1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444 |
- :github_url: hide
- .. DO NOT EDIT THIS FILE!!!
- .. Generated automatically from Godot engine sources.
- .. Generator: https://github.com/godotengine/godot/tree/4.2/doc/tools/make_rst.py.
- .. XML source: https://github.com/godotengine/godot/tree/4.2/doc/classes/RenderingServer.xml.
- .. _class_RenderingServer:
- RenderingServer
- ===============
- **Inherits:** :ref:`Object<class_Object>`
- Server for anything visible.
- .. rst-class:: classref-introduction-group
- Description
- -----------
- 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.
- 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).
- 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.
- 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>`.
- \ **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>`.
- Similarly, in 2D, a canvas is needed to draw all canvas items.
- \ **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).
- \ **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_*``.
- \ **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.
- .. rst-class:: classref-introduction-group
- Tutorials
- ---------
- - :doc:`Optimization using Servers <../tutorials/performance/using_servers>`
- .. rst-class:: classref-reftable-group
- Properties
- ----------
- .. table::
- :widths: auto
- +-------------------------+--------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`render_loop_enabled<class_RenderingServer_property_render_loop_enabled>` |
- +-------------------------+--------------------------------------------------------------------------------+
- .. rst-class:: classref-reftable-group
- Methods
- -------
- .. table::
- :widths: auto
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`call_on_render_thread<class_RenderingServer_method_call_on_render_thread>` **(** :ref:`Callable<class_Callable>` callable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`camera_create<class_RenderingServer_method_camera_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`camera_set_camera_attributes<class_RenderingServer_method_camera_set_camera_attributes>` **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` effects **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`camera_set_cull_mask<class_RenderingServer_method_camera_set_cull_mask>` **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`camera_set_environment<class_RenderingServer_method_camera_set_environment>` **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`camera_set_transform<class_RenderingServer_method_camera_set_transform>` **(** :ref:`RID<class_RID>` camera, :ref:`Transform3D<class_Transform3D>` transform **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`canvas_create<class_RenderingServer_method_canvas_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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() **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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() **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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) **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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() **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_item_clear<class_RenderingServer_method_canvas_item_clear>` **(** :ref:`RID<class_RID>` item **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`canvas_item_create<class_RenderingServer_method_canvas_item_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_item_set_clip<class_RenderingServer_method_canvas_item_set_clip>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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) **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_item_set_material<class_RenderingServer_method_canvas_item_set_material>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_item_set_modulate<class_RenderingServer_method_canvas_item_set_modulate>` **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_item_set_parent<class_RenderingServer_method_canvas_item_set_parent>` **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_item_set_transform<class_RenderingServer_method_canvas_item_set_transform>` **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_item_set_visible<class_RenderingServer_method_canvas_item_set_visible>` **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`canvas_light_create<class_RenderingServer_method_canvas_light_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`canvas_light_occluder_create<class_RenderingServer_method_canvas_light_occluder_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_light_set_color<class_RenderingServer_method_canvas_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_light_set_enabled<class_RenderingServer_method_canvas_light_set_enabled>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_light_set_energy<class_RenderingServer_method_canvas_light_set_energy>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_light_set_height<class_RenderingServer_method_canvas_light_set_height>` **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_light_set_mode<class_RenderingServer_method_canvas_light_set_mode>` **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` mode **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_light_set_texture<class_RenderingServer_method_canvas_light_set_texture>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_light_set_transform<class_RenderingServer_method_canvas_light_set_transform>` **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`canvas_occluder_polygon_create<class_RenderingServer_method_canvas_occluder_polygon_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_set_disable_scale<class_RenderingServer_method_canvas_set_disable_scale>` **(** :ref:`bool<class_bool>` disable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_set_modulate<class_RenderingServer_method_canvas_set_modulate>` **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`canvas_set_shadow_texture_size<class_RenderingServer_method_canvas_set_shadow_texture_size>` **(** :ref:`int<class_int>` size **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`canvas_texture_create<class_RenderingServer_method_canvas_texture_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_rendering_device<class_RenderingServer_method_create_local_rendering_device>` **(** **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Rect2<class_Rect2>` | :ref:`debug_canvas_item_get_rect<class_RenderingServer_method_debug_canvas_item_get_rect>` **(** :ref:`RID<class_RID>` item **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`decal_create<class_RenderingServer_method_decal_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`decal_set_albedo_mix<class_RenderingServer_method_decal_set_albedo_mix>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` albedo_mix **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`decal_set_cull_mask<class_RenderingServer_method_decal_set_cull_mask>` **(** :ref:`RID<class_RID>` decal, :ref:`int<class_int>` mask **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`decal_set_emission_energy<class_RenderingServer_method_decal_set_emission_energy>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` energy **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`decal_set_modulate<class_RenderingServer_method_decal_set_modulate>` **(** :ref:`RID<class_RID>` decal, :ref:`Color<class_Color>` color **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`decal_set_normal_fade<class_RenderingServer_method_decal_set_normal_fade>` **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` fade **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`decal_set_size<class_RenderingServer_method_decal_set_size>` **(** :ref:`RID<class_RID>` decal, :ref:`Vector3<class_Vector3>` size **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`decals_set_filter<class_RenderingServer_method_decals_set_filter>` **(** :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` filter **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`directional_light_create<class_RenderingServer_method_directional_light_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`directional_soft_shadow_filter_set_quality<class_RenderingServer_method_directional_soft_shadow_filter_set_quality>` **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`environment_create<class_RenderingServer_method_environment_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`environment_glow_set_use_bicubic_upscale<class_RenderingServer_method_environment_glow_set_use_bicubic_upscale>` **(** :ref:`bool<class_bool>` enable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`environment_set_background<class_RenderingServer_method_environment_set_background>` **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` bg **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`environment_set_bg_color<class_RenderingServer_method_environment_set_bg_color>` **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`environment_set_sdfgi_frames_to_converge<class_RenderingServer_method_environment_set_sdfgi_frames_to_converge>` **(** :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` frames **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`environment_set_sdfgi_ray_count<class_RenderingServer_method_environment_set_sdfgi_ray_count>` **(** :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` ray_count **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`environment_set_sky<class_RenderingServer_method_environment_set_sky>` **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`environment_set_sky_orientation<class_RenderingServer_method_environment_set_sky_orientation>` **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`environment_set_ssr_roughness_quality<class_RenderingServer_method_environment_set_ssr_roughness_quality>` **(** :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` quality **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`environment_set_volumetric_fog_filter_active<class_RenderingServer_method_environment_set_volumetric_fog_filter_active>` **(** :ref:`bool<class_bool>` active **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`fog_volume_create<class_RenderingServer_method_fog_volume_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`fog_volume_set_material<class_RenderingServer_method_fog_volume_set_material>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`RID<class_RID>` material **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`fog_volume_set_size<class_RenderingServer_method_fog_volume_set_size>` **(** :ref:`RID<class_RID>` fog_volume, :ref:`Vector3<class_Vector3>` size **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`force_draw<class_RenderingServer_method_force_draw>` **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`force_sync<class_RenderingServer_method_force_sync>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`free_rid<class_RenderingServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Color<class_Color>` | :ref:`get_default_clear_color<class_RenderingServer_method_get_default_clear_color>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`float<class_float>` | :ref:`get_frame_setup_time_cpu<class_RenderingServer_method_get_frame_setup_time_cpu>` **(** **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`get_rendering_device<class_RenderingServer_method_get_rendering_device>` **(** **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>` **(** :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` info **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Dictionary[]<class_Dictionary>` | :ref:`get_shader_parameter_list<class_RenderingServer_method_get_shader_parameter_list>` **(** :ref:`RID<class_RID>` shader **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`get_test_cube<class_RenderingServer_method_get_test_cube>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`get_test_texture<class_RenderingServer_method_get_test_texture>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_video_adapter_api_version<class_RenderingServer_method_get_video_adapter_api_version>` **(** **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_video_adapter_name<class_RenderingServer_method_get_video_adapter_name>` **(** **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`DeviceType<enum_RenderingDevice_DeviceType>` | :ref:`get_video_adapter_type<class_RenderingServer_method_get_video_adapter_type>` **(** **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_video_adapter_vendor<class_RenderingServer_method_get_video_adapter_vendor>` **(** **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`get_white_texture<class_RenderingServer_method_get_white_texture>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`gi_set_use_half_resolution<class_RenderingServer_method_gi_set_use_half_resolution>` **(** :ref:`bool<class_bool>` half_resolution **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Variant<class_Variant>` | :ref:`global_shader_parameter_get<class_RenderingServer_method_global_shader_parameter_get>` **(** :ref:`StringName<class_StringName>` name **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`StringName[]<class_StringName>` | :ref:`global_shader_parameter_get_list<class_RenderingServer_method_global_shader_parameter_get_list>` **(** **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`global_shader_parameter_remove<class_RenderingServer_method_global_shader_parameter_remove>` **(** :ref:`StringName<class_StringName>` name **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`global_shader_parameter_set<class_RenderingServer_method_global_shader_parameter_set>` **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_changed<class_RenderingServer_method_has_changed>` **(** **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_feature<class_RenderingServer_method_has_feature>` **(** :ref:`Features<enum_RenderingServer_Features>` feature **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`has_os_feature<class_RenderingServer_method_has_os_feature>` **(** :ref:`String<class_String>` feature **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_attach_skeleton<class_RenderingServer_method_instance_attach_skeleton>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`instance_create<class_RenderingServer_method_instance_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`instance_create2<class_RenderingServer_method_instance_create2>` **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_geometry_set_transparency<class_RenderingServer_method_instance_geometry_set_transparency>` **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` transparency **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_set_base<class_RenderingServer_method_instance_set_base>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_set_custom_aabb<class_RenderingServer_method_instance_set_custom_aabb>` **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_set_ignore_culling<class_RenderingServer_method_instance_set_ignore_culling>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_set_layer_mask<class_RenderingServer_method_instance_set_layer_mask>` **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_set_scenario<class_RenderingServer_method_instance_set_scenario>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_set_transform<class_RenderingServer_method_instance_set_transform>` **(** :ref:`RID<class_RID>` instance, :ref:`Transform3D<class_Transform3D>` transform **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_set_visibility_parent<class_RenderingServer_method_instance_set_visibility_parent>` **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` parent **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`instance_set_visible<class_RenderingServer_method_instance_set_visible>` **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`light_projectors_set_filter<class_RenderingServer_method_light_projectors_set_filter>` **(** :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` filter **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`light_set_color<class_RenderingServer_method_light_set_color>` **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`light_set_cull_mask<class_RenderingServer_method_light_set_cull_mask>` **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`light_set_negative<class_RenderingServer_method_light_set_negative>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`light_set_projector<class_RenderingServer_method_light_set_projector>` **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`light_set_shadow<class_RenderingServer_method_light_set_shadow>` **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`lightmap_create<class_RenderingServer_method_lightmap_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`lightmap_get_probe_capture_points<class_RenderingServer_method_lightmap_get_probe_capture_points>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedColorArray<class_PackedColorArray>` | :ref:`lightmap_get_probe_capture_sh<class_RenderingServer_method_lightmap_get_probe_capture_sh>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`lightmap_get_probe_capture_tetrahedra<class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra>` **(** :ref:`RID<class_RID>` lightmap **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`lightmap_set_probe_bounds<class_RenderingServer_method_lightmap_set_probe_bounds>` **(** :ref:`RID<class_RID>` lightmap, :ref:`AABB<class_AABB>` bounds **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`lightmap_set_probe_capture_update_speed<class_RenderingServer_method_lightmap_set_probe_capture_update_speed>` **(** :ref:`float<class_float>` speed **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`lightmap_set_probe_interior<class_RenderingServer_method_lightmap_set_probe_interior>` **(** :ref:`RID<class_RID>` lightmap, :ref:`bool<class_bool>` interior **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`material_create<class_RenderingServer_method_material_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`material_set_next_pass<class_RenderingServer_method_material_set_next_pass>` **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`material_set_render_priority<class_RenderingServer_method_material_set_render_priority>` **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`material_set_shader<class_RenderingServer_method_material_set_shader>` **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`mesh_add_surface<class_RenderingServer_method_mesh_add_surface>` **(** :ref:`RID<class_RID>` mesh, :ref:`Dictionary<class_Dictionary>` surface **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`mesh_clear<class_RenderingServer_method_mesh_clear>` **(** :ref:`RID<class_RID>` mesh **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`mesh_create<class_RenderingServer_method_mesh_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_count<class_RenderingServer_method_mesh_get_blend_shape_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`AABB<class_AABB>` | :ref:`mesh_get_custom_aabb<class_RenderingServer_method_mesh_get_custom_aabb>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Dictionary<class_Dictionary>` | :ref:`mesh_get_surface<class_RenderingServer_method_mesh_get_surface>` **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`mesh_get_surface_count<class_RenderingServer_method_mesh_get_surface_count>` **(** :ref:`RID<class_RID>` mesh **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`mesh_set_custom_aabb<class_RenderingServer_method_mesh_set_custom_aabb>` **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`mesh_set_shadow_mesh<class_RenderingServer_method_mesh_set_shadow_mesh>` **(** :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` shadow_mesh **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`mesh_surface_get_format_normal_tangent_stride<class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride>` **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`multimesh_create<class_RenderingServer_method_multimesh_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`AABB<class_AABB>` | :ref:`multimesh_get_aabb<class_RenderingServer_method_multimesh_get_aabb>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`multimesh_get_buffer<class_RenderingServer_method_multimesh_get_buffer>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`multimesh_get_instance_count<class_RenderingServer_method_multimesh_get_instance_count>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`multimesh_get_mesh<class_RenderingServer_method_multimesh_get_mesh>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`multimesh_get_visible_instances<class_RenderingServer_method_multimesh_get_visible_instances>` **(** :ref:`RID<class_RID>` multimesh **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`multimesh_set_buffer<class_RenderingServer_method_multimesh_set_buffer>` **(** :ref:`RID<class_RID>` multimesh, :ref:`PackedFloat32Array<class_PackedFloat32Array>` buffer **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`multimesh_set_mesh<class_RenderingServer_method_multimesh_set_mesh>` **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`multimesh_set_visible_instances<class_RenderingServer_method_multimesh_set_visible_instances>` **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`occluder_create<class_RenderingServer_method_occluder_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`omni_light_create<class_RenderingServer_method_omni_light_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`particles_collision_create<class_RenderingServer_method_particles_collision_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_collision_height_field_update<class_RenderingServer_method_particles_collision_height_field_update>` **(** :ref:`RID<class_RID>` particles_collision **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`particles_create<class_RenderingServer_method_particles_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`AABB<class_AABB>` | :ref:`particles_get_current_aabb<class_RenderingServer_method_particles_get_current_aabb>` **(** :ref:`RID<class_RID>` particles **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`particles_get_emitting<class_RenderingServer_method_particles_get_emitting>` **(** :ref:`RID<class_RID>` particles **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`particles_is_inactive<class_RenderingServer_method_particles_is_inactive>` **(** :ref:`RID<class_RID>` particles **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_request_process<class_RenderingServer_method_particles_request_process>` **(** :ref:`RID<class_RID>` particles **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_restart<class_RenderingServer_method_particles_restart>` **(** :ref:`RID<class_RID>` particles **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_amount<class_RenderingServer_method_particles_set_amount>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_amount_ratio<class_RenderingServer_method_particles_set_amount_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_custom_aabb<class_RenderingServer_method_particles_set_custom_aabb>` **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_draw_order<class_RenderingServer_method_particles_set_draw_order>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` order **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_draw_passes<class_RenderingServer_method_particles_set_draw_passes>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_emission_transform<class_RenderingServer_method_particles_set_emission_transform>` **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_emitter_velocity<class_RenderingServer_method_particles_set_emitter_velocity>` **(** :ref:`RID<class_RID>` particles, :ref:`Vector3<class_Vector3>` velocity **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_emitting<class_RenderingServer_method_particles_set_emitting>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_explosiveness_ratio<class_RenderingServer_method_particles_set_explosiveness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_fixed_fps<class_RenderingServer_method_particles_set_fixed_fps>` **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_fractional_delta<class_RenderingServer_method_particles_set_fractional_delta>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_interp_to_end<class_RenderingServer_method_particles_set_interp_to_end>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` factor **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_interpolate<class_RenderingServer_method_particles_set_interpolate>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_lifetime<class_RenderingServer_method_particles_set_lifetime>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_mode<class_RenderingServer_method_particles_set_mode>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` mode **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_one_shot<class_RenderingServer_method_particles_set_one_shot>` **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_process_material<class_RenderingServer_method_particles_set_process_material>` **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_randomness_ratio<class_RenderingServer_method_particles_set_randomness_ratio>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_speed_scale<class_RenderingServer_method_particles_set_speed_scale>` **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_subemitter<class_RenderingServer_method_particles_set_subemitter>` **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` subemitter_particles **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`particles_set_transform_align<class_RenderingServer_method_particles_set_transform_align>` **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` align **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`positional_soft_shadow_filter_set_quality<class_RenderingServer_method_positional_soft_shadow_filter_set_quality>` **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`reflection_probe_create<class_RenderingServer_method_reflection_probe_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`reflection_probe_set_intensity<class_RenderingServer_method_reflection_probe_set_intensity>` **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`reflection_probe_set_resolution<class_RenderingServer_method_reflection_probe_set_resolution>` **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` resolution **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`reflection_probe_set_size<class_RenderingServer_method_reflection_probe_set_size>` **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` size **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`request_frame_drawn_callback<class_RenderingServer_method_request_frame_drawn_callback>` **(** :ref:`Callable<class_Callable>` callable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`scenario_create<class_RenderingServer_method_scenario_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`scenario_set_camera_attributes<class_RenderingServer_method_scenario_set_camera_attributes>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` effects **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`scenario_set_environment<class_RenderingServer_method_scenario_set_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`scenario_set_fallback_environment<class_RenderingServer_method_scenario_set_fallback_environment>` **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_debug_generate_wireframes<class_RenderingServer_method_set_debug_generate_wireframes>` **(** :ref:`bool<class_bool>` generate **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_default_clear_color<class_RenderingServer_method_set_default_clear_color>` **(** :ref:`Color<class_Color>` color **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`shader_create<class_RenderingServer_method_shader_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`shader_get_code<class_RenderingServer_method_shader_get_code>` **(** :ref:`RID<class_RID>` shader **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`shader_set_code<class_RenderingServer_method_shader_set_code>` **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` code **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`shader_set_path_hint<class_RenderingServer_method_shader_set_path_hint>` **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` path **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`skeleton_create<class_RenderingServer_method_skeleton_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`skeleton_get_bone_count<class_RenderingServer_method_skeleton_get_bone_count>` **(** :ref:`RID<class_RID>` skeleton **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`sky_create<class_RenderingServer_method_sky_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`sky_set_material<class_RenderingServer_method_sky_set_material>` **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` material **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`sky_set_mode<class_RenderingServer_method_sky_set_mode>` **(** :ref:`RID<class_RID>` sky, :ref:`SkyMode<enum_RenderingServer_SkyMode>` mode **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`sky_set_radiance_size<class_RenderingServer_method_sky_set_radiance_size>` **(** :ref:`RID<class_RID>` sky, :ref:`int<class_int>` radiance_size **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`spot_light_create<class_RenderingServer_method_spot_light_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`sub_surface_scattering_set_quality<class_RenderingServer_method_sub_surface_scattering_set_quality>` **(** :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` quality **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`texture_2d_create<class_RenderingServer_method_texture_2d_create>` **(** :ref:`Image<class_Image>` image **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Image<class_Image>` | :ref:`texture_2d_get<class_RenderingServer_method_texture_2d_get>` **(** :ref:`RID<class_RID>` texture **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`texture_2d_placeholder_create<class_RenderingServer_method_texture_2d_placeholder_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Image[]<class_Image>` | :ref:`texture_3d_get<class_RenderingServer_method_texture_3d_get>` **(** :ref:`RID<class_RID>` texture **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`texture_3d_placeholder_create<class_RenderingServer_method_texture_3d_placeholder_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`texture_3d_update<class_RenderingServer_method_texture_3d_update>` **(** :ref:`RID<class_RID>` texture, :ref:`Image[]<class_Image>` data **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Format<enum_Image_Format>` | :ref:`texture_get_format<class_RenderingServer_method_texture_get_format>` **(** :ref:`RID<class_RID>` texture **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`texture_get_path<class_RenderingServer_method_texture_get_path>` **(** :ref:`RID<class_RID>` texture **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`texture_proxy_create<class_RenderingServer_method_texture_proxy_create>` **(** :ref:`RID<class_RID>` base **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`texture_proxy_update<class_RenderingServer_method_texture_proxy_update>` **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` proxy_to **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`texture_replace<class_RenderingServer_method_texture_replace>` **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` by_texture **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`texture_set_path<class_RenderingServer_method_texture_set_path>` **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_attach_camera<class_RenderingServer_method_viewport_attach_camera>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_attach_canvas<class_RenderingServer_method_viewport_attach_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`viewport_create<class_RenderingServer_method_viewport_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`viewport_get_render_target<class_RenderingServer_method_viewport_get_render_target>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`viewport_get_texture<class_RenderingServer_method_viewport_get_texture>` **(** :ref:`RID<class_RID>` viewport **)** |const| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_remove_canvas<class_RenderingServer_method_viewport_remove_canvas>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_active<class_RenderingServer_method_viewport_set_active>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_debug_draw<class_RenderingServer_method_viewport_set_debug_draw>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` draw **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_disable_2d<class_RenderingServer_method_viewport_set_disable_2d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_disable_3d<class_RenderingServer_method_viewport_set_disable_3d>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_environment_mode<class_RenderingServer_method_viewport_set_environment_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` mode **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_fsr_sharpness<class_RenderingServer_method_viewport_set_fsr_sharpness>` **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` sharpness **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_msaa_2d<class_RenderingServer_method_viewport_set_msaa_2d>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_msaa_3d<class_RenderingServer_method_viewport_set_msaa_3d>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_occlusion_culling_build_quality<class_RenderingServer_method_viewport_set_occlusion_culling_build_quality>` **(** :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` quality **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_occlusion_rays_per_thread<class_RenderingServer_method_viewport_set_occlusion_rays_per_thread>` **(** :ref:`int<class_int>` rays_per_thread **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_parent_viewport<class_RenderingServer_method_viewport_set_parent_viewport>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_scenario<class_RenderingServer_method_viewport_set_scenario>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_transparent_background<class_RenderingServer_method_viewport_set_transparent_background>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_use_debanding<class_RenderingServer_method_viewport_set_use_debanding>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_use_taa<class_RenderingServer_method_viewport_set_use_taa>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_use_xr<class_RenderingServer_method_viewport_set_use_xr>` **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_xr **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_vrs_mode<class_RenderingServer_method_viewport_set_vrs_mode>` **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` mode **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`viewport_set_vrs_texture<class_RenderingServer_method_viewport_set_vrs_texture>` **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` texture **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`visibility_notifier_create<class_RenderingServer_method_visibility_notifier_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`visibility_notifier_set_aabb<class_RenderingServer_method_visibility_notifier_set_aabb>` **(** :ref:`RID<class_RID>` notifier, :ref:`AABB<class_AABB>` aabb **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`voxel_gi_create<class_RenderingServer_method_voxel_gi_create>` **(** **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :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| |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`voxel_gi_set_bias<class_RenderingServer_method_voxel_gi_set_bias>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`voxel_gi_set_energy<class_RenderingServer_method_voxel_gi_set_energy>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` energy **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`voxel_gi_set_interior<class_RenderingServer_method_voxel_gi_set_interior>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`voxel_gi_set_propagation<class_RenderingServer_method_voxel_gi_set_propagation>` **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` amount **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`voxel_gi_set_quality<class_RenderingServer_method_voxel_gi_set_quality>` **(** :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` quality **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | 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 **)** |
- +----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Signals
- -------
- .. _class_RenderingServer_signal_frame_post_draw:
- .. rst-class:: classref-signal
- **frame_post_draw** **(** **)**
- Emitted at the end of the frame, after the RenderingServer has finished updating all the Viewports.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_signal_frame_pre_draw:
- .. rst-class:: classref-signal
- **frame_pre_draw** **(** **)**
- Emitted at the beginning of the frame, before the RenderingServer updates all the Viewports.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Enumerations
- ------------
- .. _enum_RenderingServer_TextureLayeredType:
- .. rst-class:: classref-enumeration
- enum **TextureLayeredType**:
- .. _class_RenderingServer_constant_TEXTURE_LAYERED_2D_ARRAY:
- .. rst-class:: classref-enumeration-constant
- :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_2D_ARRAY** = ``0``
- Array of 2-dimensional textures (see :ref:`Texture2DArray<class_Texture2DArray>`).
- .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP:
- .. rst-class:: classref-enumeration-constant
- :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP** = ``1``
- Cubemap texture (see :ref:`Cubemap<class_Cubemap>`).
- .. _class_RenderingServer_constant_TEXTURE_LAYERED_CUBEMAP_ARRAY:
- .. rst-class:: classref-enumeration-constant
- :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` **TEXTURE_LAYERED_CUBEMAP_ARRAY** = ``2``
- Array of cubemap textures (see :ref:`CubemapArray<class_CubemapArray>`).
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_CubeMapLayer:
- .. rst-class:: classref-enumeration
- enum **CubeMapLayer**:
- .. _class_RenderingServer_constant_CUBEMAP_LAYER_LEFT:
- .. rst-class:: classref-enumeration-constant
- :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_LEFT** = ``0``
- Left face of a :ref:`Cubemap<class_Cubemap>`.
- .. _class_RenderingServer_constant_CUBEMAP_LAYER_RIGHT:
- .. rst-class:: classref-enumeration-constant
- :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_RIGHT** = ``1``
- Right face of a :ref:`Cubemap<class_Cubemap>`.
- .. _class_RenderingServer_constant_CUBEMAP_LAYER_BOTTOM:
- .. rst-class:: classref-enumeration-constant
- :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BOTTOM** = ``2``
- Bottom face of a :ref:`Cubemap<class_Cubemap>`.
- .. _class_RenderingServer_constant_CUBEMAP_LAYER_TOP:
- .. rst-class:: classref-enumeration-constant
- :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_TOP** = ``3``
- Top face of a :ref:`Cubemap<class_Cubemap>`.
- .. _class_RenderingServer_constant_CUBEMAP_LAYER_FRONT:
- .. rst-class:: classref-enumeration-constant
- :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_FRONT** = ``4``
- Front face of a :ref:`Cubemap<class_Cubemap>`.
- .. _class_RenderingServer_constant_CUBEMAP_LAYER_BACK:
- .. rst-class:: classref-enumeration-constant
- :ref:`CubeMapLayer<enum_RenderingServer_CubeMapLayer>` **CUBEMAP_LAYER_BACK** = ``5``
- Back face of a :ref:`Cubemap<class_Cubemap>`.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ShaderMode:
- .. rst-class:: classref-enumeration
- enum **ShaderMode**:
- .. _class_RenderingServer_constant_SHADER_SPATIAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SPATIAL** = ``0``
- Shader is a 3D shader.
- .. _class_RenderingServer_constant_SHADER_CANVAS_ITEM:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_CANVAS_ITEM** = ``1``
- Shader is a 2D shader.
- .. _class_RenderingServer_constant_SHADER_PARTICLES:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_PARTICLES** = ``2``
- Shader is a particle shader (can be used in both 2D and 3D).
- .. _class_RenderingServer_constant_SHADER_SKY:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_SKY** = ``3``
- Shader is a 3D sky shader.
- .. _class_RenderingServer_constant_SHADER_FOG:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_FOG** = ``4``
- Shader is a 3D fog shader.
- .. _class_RenderingServer_constant_SHADER_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` **SHADER_MAX** = ``5``
- Represents the size of the :ref:`ShaderMode<enum_RenderingServer_ShaderMode>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ArrayType:
- .. rst-class:: classref-enumeration
- enum **ArrayType**:
- .. _class_RenderingServer_constant_ARRAY_VERTEX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_VERTEX** = ``0``
- Array is a vertex position array.
- .. _class_RenderingServer_constant_ARRAY_NORMAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_NORMAL** = ``1``
- Array is a normal array.
- .. _class_RenderingServer_constant_ARRAY_TANGENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TANGENT** = ``2``
- Array is a tangent array.
- .. _class_RenderingServer_constant_ARRAY_COLOR:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_COLOR** = ``3``
- Array is a vertex color array.
- .. _class_RenderingServer_constant_ARRAY_TEX_UV:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV** = ``4``
- Array is a UV coordinates array.
- .. _class_RenderingServer_constant_ARRAY_TEX_UV2:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_TEX_UV2** = ``5``
- Array is a UV coordinates array for the second set of UV coordinates.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM0:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM0** = ``6``
- Array is a custom data array for the first set of custom data.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM1:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM1** = ``7``
- Array is a custom data array for the second set of custom data.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM2:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM2** = ``8``
- Array is a custom data array for the third set of custom data.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM3:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_CUSTOM3** = ``9``
- Array is a custom data array for the fourth set of custom data.
- .. _class_RenderingServer_constant_ARRAY_BONES:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_BONES** = ``10``
- Array contains bone information.
- .. _class_RenderingServer_constant_ARRAY_WEIGHTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_WEIGHTS** = ``11``
- Array is weight information.
- .. _class_RenderingServer_constant_ARRAY_INDEX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_INDEX** = ``12``
- Array is an index array.
- .. _class_RenderingServer_constant_ARRAY_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayType<enum_RenderingServer_ArrayType>` **ARRAY_MAX** = ``13``
- Represents the size of the :ref:`ArrayType<enum_RenderingServer_ArrayType>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ArrayCustomFormat:
- .. rst-class:: classref-enumeration
- enum **ArrayCustomFormat**:
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_UNORM:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_UNORM** = ``0``
- 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.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA8_SNORM:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA8_SNORM** = ``1``
- 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.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_HALF:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_HALF** = ``2``
- Custom data array contains 16-bit-per-channel red/green color data. Values are floating-point in half precision.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_HALF:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_HALF** = ``3``
- Custom data array contains 16-bit-per-channel red/green/blue/alpha color data. Values are floating-point in half precision.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_R_FLOAT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_R_FLOAT** = ``4``
- Custom data array contains 32-bit-per-channel red color data. Values are floating-point in single precision.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_RG_FLOAT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RG_FLOAT** = ``5``
- Custom data array contains 32-bit-per-channel red/green color data. Values are floating-point in single precision.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGB_FLOAT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGB_FLOAT** = ``6``
- Custom data array contains 32-bit-per-channel red/green/blue color data. Values are floating-point in single precision.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_RGBA_FLOAT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_RGBA_FLOAT** = ``7``
- Custom data array contains 32-bit-per-channel red/green/blue/alpha color data. Values are floating-point in single precision.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` **ARRAY_CUSTOM_MAX** = ``8``
- Represents the size of the :ref:`ArrayCustomFormat<enum_RenderingServer_ArrayCustomFormat>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ArrayFormat:
- .. rst-class:: classref-enumeration
- flags **ArrayFormat**:
- .. _class_RenderingServer_constant_ARRAY_FORMAT_VERTEX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_VERTEX** = ``1``
- Flag used to mark a vertex position array.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_NORMAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_NORMAL** = ``2``
- Flag used to mark a normal array.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_TANGENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TANGENT** = ``4``
- Flag used to mark a tangent array.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_COLOR:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_COLOR** = ``8``
- Flag used to mark a vertex color array.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV** = ``16``
- Flag used to mark a UV coordinates array.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_TEX_UV2:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_TEX_UV2** = ``32``
- Flag used to mark a UV coordinates array for the second UV coordinates.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0** = ``64``
- Flag used to mark an array of custom per-vertex data for the first set of custom data.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1** = ``128``
- Flag used to mark an array of custom per-vertex data for the second set of custom data.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2** = ``256``
- Flag used to mark an array of custom per-vertex data for the third set of custom data.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3** = ``512``
- Flag used to mark an array of custom per-vertex data for the fourth set of custom data.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_BONES:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BONES** = ``1024``
- Flag used to mark a bone information array.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_WEIGHTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_WEIGHTS** = ``2048``
- Flag used to mark a weights array.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_INDEX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_INDEX** = ``4096``
- Flag used to mark an index array.
- .. _class_RenderingServer_constant_ARRAY_FORMAT_BLEND_SHAPE_MASK:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_BLEND_SHAPE_MASK** = ``7``
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BASE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BASE** = ``13``
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_BITS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_BITS** = ``3``
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM0_SHIFT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM0_SHIFT** = ``13``
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM1_SHIFT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM1_SHIFT** = ``16``
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM2_SHIFT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM2_SHIFT** = ``19``
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM3_SHIFT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM3_SHIFT** = ``22``
- .. _class_RenderingServer_constant_ARRAY_FORMAT_CUSTOM_MASK:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FORMAT_CUSTOM_MASK** = ``7``
- .. _class_RenderingServer_constant_ARRAY_COMPRESS_FLAGS_BASE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_COMPRESS_FLAGS_BASE** = ``25``
- .. _class_RenderingServer_constant_ARRAY_FLAG_USE_2D_VERTICES:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_2D_VERTICES** = ``33554432``
- Flag used to mark that the array contains 2D vertices.
- .. _class_RenderingServer_constant_ARRAY_FLAG_USE_DYNAMIC_UPDATE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_DYNAMIC_UPDATE** = ``67108864``
- .. _class_RenderingServer_constant_ARRAY_FLAG_USE_8_BONE_WEIGHTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USE_8_BONE_WEIGHTS** = ``134217728``
- Flag used to mark that the array uses 8 bone weights instead of 4.
- .. _class_RenderingServer_constant_ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY** = ``268435456``
- Flag used to mark that the mesh does not have a vertex array and instead will infer vertex positions in the shader using indices and other information.
- .. _class_RenderingServer_constant_ARRAY_FLAG_COMPRESS_ATTRIBUTES:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_COMPRESS_ATTRIBUTES** = ``536870912``
- Flag used to mark that a mesh is using compressed attributes (vertices, normals, tangents, UVs). When this form of compression is enabled, vertex positions will be packed into an RGBA16UNORM attribute and scaled in the vertex shader. The normal and tangent will be packed into an RG16UNORM representing an axis, and a 16-bit float stored in the A-channel of the vertex. UVs will use 16-bit normalized floats instead of full 32-bit signed floats. When using this compression mode you must use either vertices, normals, and tangents or only vertices. You cannot use normals without tangents. Importers will automatically enable this compression if they can.
- .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_BASE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_BASE** = ``35``
- Flag used to mark the start of the bits used to store the mesh version.
- .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_SHIFT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_SHIFT** = ``35``
- Flag used to shift a mesh format int to bring the version into the lowest digits.
- .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_1:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_1** = ``0``
- Flag used to record the format used by prior mesh versions before the introduction of a version.
- .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_2:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_2** = ``34359738368``
- Flag used to record the second iteration of the mesh version flag. The primary difference between this and :ref:`ARRAY_FLAG_FORMAT_VERSION_1<class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_1>` is that this version supports :ref:`ARRAY_FLAG_COMPRESS_ATTRIBUTES<class_RenderingServer_constant_ARRAY_FLAG_COMPRESS_ATTRIBUTES>` and in this version vertex positions are de-interleaved from normals and tangents.
- .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_CURRENT_VERSION:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_CURRENT_VERSION** = ``34359738368``
- Flag used to record the current version that the engine expects. Currently this is the same as :ref:`ARRAY_FLAG_FORMAT_VERSION_2<class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_2>`.
- .. _class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_MASK:
- .. rst-class:: classref-enumeration-constant
- :ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>` **ARRAY_FLAG_FORMAT_VERSION_MASK** = ``255``
- Flag used to isolate the bits used for mesh version after using :ref:`ARRAY_FLAG_FORMAT_VERSION_SHIFT<class_RenderingServer_constant_ARRAY_FLAG_FORMAT_VERSION_SHIFT>` to shift them into place.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_PrimitiveType:
- .. rst-class:: classref-enumeration
- enum **PrimitiveType**:
- .. _class_RenderingServer_constant_PRIMITIVE_POINTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_POINTS** = ``0``
- Primitive to draw consists of points.
- .. _class_RenderingServer_constant_PRIMITIVE_LINES:
- .. rst-class:: classref-enumeration-constant
- :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINES** = ``1``
- Primitive to draw consists of lines.
- .. _class_RenderingServer_constant_PRIMITIVE_LINE_STRIP:
- .. rst-class:: classref-enumeration-constant
- :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_LINE_STRIP** = ``2``
- Primitive to draw consists of a line strip from start to end.
- .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLES:
- .. rst-class:: classref-enumeration-constant
- :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLES** = ``3``
- Primitive to draw consists of triangles.
- .. _class_RenderingServer_constant_PRIMITIVE_TRIANGLE_STRIP:
- .. rst-class:: classref-enumeration-constant
- :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_TRIANGLE_STRIP** = ``4``
- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
- .. _class_RenderingServer_constant_PRIMITIVE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` **PRIMITIVE_MAX** = ``5``
- Represents the size of the :ref:`PrimitiveType<enum_RenderingServer_PrimitiveType>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_BlendShapeMode:
- .. rst-class:: classref-enumeration
- enum **BlendShapeMode**:
- .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_NORMALIZED:
- .. rst-class:: classref-enumeration-constant
- :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_NORMALIZED** = ``0``
- Blend shapes are normalized.
- .. _class_RenderingServer_constant_BLEND_SHAPE_MODE_RELATIVE:
- .. rst-class:: classref-enumeration-constant
- :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **BLEND_SHAPE_MODE_RELATIVE** = ``1``
- Blend shapes are relative to base weight.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_MultimeshTransformFormat:
- .. rst-class:: classref-enumeration
- enum **MultimeshTransformFormat**:
- .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_2D:
- .. rst-class:: classref-enumeration-constant
- :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_2D** = ``0``
- Use :ref:`Transform2D<class_Transform2D>` to store MultiMesh transform.
- .. _class_RenderingServer_constant_MULTIMESH_TRANSFORM_3D:
- .. rst-class:: classref-enumeration-constant
- :ref:`MultimeshTransformFormat<enum_RenderingServer_MultimeshTransformFormat>` **MULTIMESH_TRANSFORM_3D** = ``1``
- Use :ref:`Transform3D<class_Transform3D>` to store MultiMesh transform.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_LightProjectorFilter:
- .. rst-class:: classref-enumeration
- enum **LightProjectorFilter**:
- .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST** = ``0``
- 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.
- .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR** = ``1``
- 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.
- .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS** = ``2``
- 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.
- .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS** = ``3``
- 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.
- .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
- 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>`.
- .. _class_RenderingServer_constant_LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` **LIGHT_PROJECTOR_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_LightType:
- .. rst-class:: classref-enumeration
- enum **LightType**:
- .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_DIRECTIONAL** = ``0``
- Directional (sun/moon) light (see :ref:`DirectionalLight3D<class_DirectionalLight3D>`).
- .. _class_RenderingServer_constant_LIGHT_OMNI:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_OMNI** = ``1``
- Omni light (see :ref:`OmniLight3D<class_OmniLight3D>`).
- .. _class_RenderingServer_constant_LIGHT_SPOT:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightType<enum_RenderingServer_LightType>` **LIGHT_SPOT** = ``2``
- Spot light (see :ref:`SpotLight3D<class_SpotLight3D>`).
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_LightParam:
- .. rst-class:: classref-enumeration
- enum **LightParam**:
- .. _class_RenderingServer_constant_LIGHT_PARAM_ENERGY:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ENERGY** = ``0``
- The light's energy multiplier.
- .. _class_RenderingServer_constant_LIGHT_PARAM_INDIRECT_ENERGY:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INDIRECT_ENERGY** = ``1``
- 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>`).
- .. _class_RenderingServer_constant_LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_VOLUMETRIC_FOG_ENERGY** = ``2``
- 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>`).
- .. _class_RenderingServer_constant_LIGHT_PARAM_SPECULAR:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPECULAR** = ``3``
- The light's influence on specularity.
- .. _class_RenderingServer_constant_LIGHT_PARAM_RANGE:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_RANGE** = ``4``
- The light's range.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SIZE:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SIZE** = ``5``
- The size of the light when using spot light or omni light. The angular size of the light when using directional light.
- .. _class_RenderingServer_constant_LIGHT_PARAM_ATTENUATION:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_ATTENUATION** = ``6``
- The light's attenuation.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ANGLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ANGLE** = ``7``
- The spotlight's angle.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SPOT_ATTENUATION:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SPOT_ATTENUATION** = ``8``
- The spotlight's attenuation.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_MAX_DISTANCE:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = ``9``
- 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).
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = ``10``
- Proportion of shadow atlas occupied by the first split.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = ``11``
- Proportion of shadow atlas occupied by the second split.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = ``12``
- Proportion of shadow atlas occupied by the third split. The fourth split occupies the rest.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_FADE_START:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_FADE_START** = ``13``
- Proportion of shadow max distance where the shadow will start to fade out.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_NORMAL_BIAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = ``14``
- Normal bias used to offset shadow lookup by object normal. Can be used to fix self-shadowing artifacts.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BIAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BIAS** = ``15``
- Bias the shadow lookup to fix self-shadowing artifacts.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_PANCAKE_SIZE:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_PANCAKE_SIZE** = ``16``
- 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.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_OPACITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_OPACITY** = ``17``
- 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.
- .. _class_RenderingServer_constant_LIGHT_PARAM_SHADOW_BLUR:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_SHADOW_BLUR** = ``18``
- 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.
- .. _class_RenderingServer_constant_LIGHT_PARAM_TRANSMITTANCE_BIAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_TRANSMITTANCE_BIAS** = ``19``
- .. _class_RenderingServer_constant_LIGHT_PARAM_INTENSITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_INTENSITY** = ``20``
- 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``.
- .. _class_RenderingServer_constant_LIGHT_PARAM_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightParam<enum_RenderingServer_LightParam>` **LIGHT_PARAM_MAX** = ``21``
- Represents the size of the :ref:`LightParam<enum_RenderingServer_LightParam>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_LightBakeMode:
- .. rst-class:: classref-enumeration
- enum **LightBakeMode**:
- .. _class_RenderingServer_constant_LIGHT_BAKE_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DISABLED** = ``0``
- 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.
- .. _class_RenderingServer_constant_LIGHT_BAKE_STATIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_STATIC** = ``1``
- 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.
- .. _class_RenderingServer_constant_LIGHT_BAKE_DYNAMIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` **LIGHT_BAKE_DYNAMIC** = ``2``
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_LightOmniShadowMode:
- .. rst-class:: classref-enumeration
- enum **LightOmniShadowMode**:
- .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_DUAL_PARABOLOID:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_DUAL_PARABOLOID** = ``0``
- Use a dual paraboloid shadow map for omni lights.
- .. _class_RenderingServer_constant_LIGHT_OMNI_SHADOW_CUBE:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` **LIGHT_OMNI_SHADOW_CUBE** = ``1``
- Use a cubemap shadow map for omni lights. Slower but better quality than dual paraboloid.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_LightDirectionalShadowMode:
- .. rst-class:: classref-enumeration
- enum **LightDirectionalShadowMode**:
- .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_ORTHOGONAL** = ``0``
- Use orthogonal shadow projection for directional light.
- .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_2_SPLITS** = ``1``
- Use 2 splits for shadow projection when using directional light.
- .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` **LIGHT_DIRECTIONAL_SHADOW_PARALLEL_4_SPLITS** = ``2``
- Use 4 splits for shadow projection when using directional light.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_LightDirectionalSkyMode:
- .. rst-class:: classref-enumeration
- enum **LightDirectionalSkyMode**:
- .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_AND_SKY** = ``0``
- Use DirectionalLight3D in both sky rendering and scene lighting.
- .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_LIGHT_ONLY** = ``1``
- Only use DirectionalLight3D in scene lighting.
- .. _class_RenderingServer_constant_LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY:
- .. rst-class:: classref-enumeration-constant
- :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` **LIGHT_DIRECTIONAL_SKY_MODE_SKY_ONLY** = ``2``
- Only use DirectionalLight3D in sky rendering.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ShadowQuality:
- .. rst-class:: classref-enumeration
- enum **ShadowQuality**:
- .. _class_RenderingServer_constant_SHADOW_QUALITY_HARD:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_HARD** = ``0``
- 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``.
- \ **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.
- .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_VERY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_VERY_LOW** = ``1``
- 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``).
- .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_LOW** = ``2``
- Low shadow filtering quality (fast).
- .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_MEDIUM:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_MEDIUM** = ``3``
- Medium low shadow filtering quality (average).
- .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_HIGH:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_HIGH** = ``4``
- 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``).
- .. _class_RenderingServer_constant_SHADOW_QUALITY_SOFT_ULTRA:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_SOFT_ULTRA** = ``5``
- 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``).
- .. _class_RenderingServer_constant_SHADOW_QUALITY_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` **SHADOW_QUALITY_MAX** = ``6``
- Represents the size of the :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ReflectionProbeUpdateMode:
- .. rst-class:: classref-enumeration
- enum **ReflectionProbeUpdateMode**:
- .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ONCE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ONCE** = ``0``
- Reflection probe will update reflections once and then stop.
- .. _class_RenderingServer_constant_REFLECTION_PROBE_UPDATE_ALWAYS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` **REFLECTION_PROBE_UPDATE_ALWAYS** = ``1``
- Reflection probe will update each frame. This mode is necessary to capture moving objects.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ReflectionProbeAmbientMode:
- .. rst-class:: classref-enumeration
- enum **ReflectionProbeAmbientMode**:
- .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_DISABLED** = ``0``
- Do not apply any ambient lighting inside the reflection probe's box defined by its size.
- .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_ENVIRONMENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_ENVIRONMENT** = ``1``
- Apply automatically-sourced environment lighting inside the reflection probe's box defined by its size.
- .. _class_RenderingServer_constant_REFLECTION_PROBE_AMBIENT_COLOR:
- .. rst-class:: classref-enumeration-constant
- :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` **REFLECTION_PROBE_AMBIENT_COLOR** = ``2``
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_DecalTexture:
- .. rst-class:: classref-enumeration
- enum **DecalTexture**:
- .. _class_RenderingServer_constant_DECAL_TEXTURE_ALBEDO:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ALBEDO** = ``0``
- Albedo texture slot in a decal (:ref:`Decal.texture_albedo<class_Decal_property_texture_albedo>`).
- .. _class_RenderingServer_constant_DECAL_TEXTURE_NORMAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_NORMAL** = ``1``
- Normal map texture slot in a decal (:ref:`Decal.texture_normal<class_Decal_property_texture_normal>`).
- .. _class_RenderingServer_constant_DECAL_TEXTURE_ORM:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_ORM** = ``2``
- Occlusion/Roughness/Metallic texture slot in a decal (:ref:`Decal.texture_orm<class_Decal_property_texture_orm>`).
- .. _class_RenderingServer_constant_DECAL_TEXTURE_EMISSION:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_EMISSION** = ``3``
- Emission texture slot in a decal (:ref:`Decal.texture_emission<class_Decal_property_texture_emission>`).
- .. _class_RenderingServer_constant_DECAL_TEXTURE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` **DECAL_TEXTURE_MAX** = ``4``
- Represents the size of the :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_DecalFilter:
- .. rst-class:: classref-enumeration
- enum **DecalFilter**:
- .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST** = ``0``
- 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.
- .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR** = ``1``
- 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.
- .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS** = ``2``
- 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.
- .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS** = ``3``
- 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.
- .. _class_RenderingServer_constant_DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_NEAREST_MIPMAPS_ANISOTROPIC** = ``4``
- 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>`.
- .. _class_RenderingServer_constant_DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` **DECAL_FILTER_LINEAR_MIPMAPS_ANISOTROPIC** = ``5``
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_VoxelGIQuality:
- .. rst-class:: classref-enumeration
- enum **VoxelGIQuality**:
- .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_LOW** = ``0``
- Low :ref:`VoxelGI<class_VoxelGI>` rendering quality using 4 cones.
- .. _class_RenderingServer_constant_VOXEL_GI_QUALITY_HIGH:
- .. rst-class:: classref-enumeration-constant
- :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` **VOXEL_GI_QUALITY_HIGH** = ``1``
- High :ref:`VoxelGI<class_VoxelGI>` rendering quality using 6 cones.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ParticlesMode:
- .. rst-class:: classref-enumeration
- enum **ParticlesMode**:
- .. _class_RenderingServer_constant_PARTICLES_MODE_2D:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_2D** = ``0``
- 2D particles.
- .. _class_RenderingServer_constant_PARTICLES_MODE_3D:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` **PARTICLES_MODE_3D** = ``1``
- 3D particles.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ParticlesTransformAlign:
- .. rst-class:: classref-enumeration
- enum **ParticlesTransformAlign**:
- .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_DISABLED** = ``0``
- .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD** = ``1``
- .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Y_TO_VELOCITY** = ``2``
- .. _class_RenderingServer_constant_PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` **PARTICLES_TRANSFORM_ALIGN_Z_BILLBOARD_Y_TO_VELOCITY** = ``3``
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ParticlesDrawOrder:
- .. rst-class:: classref-enumeration
- enum **ParticlesDrawOrder**:
- .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_INDEX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_INDEX** = ``0``
- Draw particles in the order that they appear in the particles array.
- .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_LIFETIME:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_LIFETIME** = ``1``
- Sort particles based on their lifetime. In other words, the particle with the highest lifetime is drawn at the front.
- .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_REVERSE_LIFETIME:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_REVERSE_LIFETIME** = ``2``
- Sort particles based on the inverse of their lifetime. In other words, the particle with the lowest lifetime is drawn at the front.
- .. _class_RenderingServer_constant_PARTICLES_DRAW_ORDER_VIEW_DEPTH:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` **PARTICLES_DRAW_ORDER_VIEW_DEPTH** = ``3``
- Sort particles based on their distance to the camera.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ParticlesCollisionType:
- .. rst-class:: classref-enumeration
- enum **ParticlesCollisionType**:
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_ATTRACT** = ``0``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_ATTRACT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_ATTRACT** = ``1``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_VECTOR_FIELD_ATTRACT** = ``2``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SPHERE_COLLIDE** = ``3``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_BOX_COLLIDE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_BOX_COLLIDE** = ``4``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_SDF_COLLIDE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_SDF_COLLIDE** = ``5``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` **PARTICLES_COLLISION_TYPE_HEIGHTFIELD_COLLIDE** = ``6``
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ParticlesCollisionHeightfieldResolution:
- .. rst-class:: classref-enumeration
- enum **ParticlesCollisionHeightfieldResolution**:
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_256** = ``0``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_512** = ``1``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_1024** = ``2``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_2048** = ``3``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_4096** = ``4``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_8192** = ``5``
- .. _class_RenderingServer_constant_PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` **PARTICLES_COLLISION_HEIGHTFIELD_RESOLUTION_MAX** = ``6``
- Represents the size of the :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_FogVolumeShape:
- .. rst-class:: classref-enumeration
- enum **FogVolumeShape**:
- .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_ELLIPSOID:
- .. rst-class:: classref-enumeration-constant
- :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_ELLIPSOID** = ``0``
- :ref:`FogVolume<class_FogVolume>` will be shaped like an ellipsoid (stretched sphere).
- .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CONE:
- .. rst-class:: classref-enumeration-constant
- :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CONE** = ``1``
- :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).
- .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_CYLINDER:
- .. rst-class:: classref-enumeration-constant
- :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_CYLINDER** = ``2``
- :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).
- .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_BOX:
- .. rst-class:: classref-enumeration-constant
- :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_BOX** = ``3``
- :ref:`FogVolume<class_FogVolume>` will be shaped like a box.
- .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_WORLD:
- .. rst-class:: classref-enumeration-constant
- :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_WORLD** = ``4``
- :ref:`FogVolume<class_FogVolume>` will have no shape, will cover the whole world and will not be culled.
- .. _class_RenderingServer_constant_FOG_VOLUME_SHAPE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` **FOG_VOLUME_SHAPE_MAX** = ``5``
- Represents the size of the :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportScaling3DMode:
- .. rst-class:: classref-enumeration
- enum **ViewportScaling3DMode**:
- .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_BILINEAR:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_BILINEAR** = ``0``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR** = ``1``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_FSR2:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_FSR2** = ``2``
- Use AMD FidelityFX Super Resolution 2.2 upscaling for the viewport's 3D buffer. The amount of scaling can be set using :ref:`Viewport.scaling_3d_scale<class_Viewport_property_scaling_3d_scale>`. Values less than ``1.0`` will be result in the viewport being upscaled using FSR2. Values greater than ``1.0`` are not supported and bilinear downsampling will be used instead. A value of ``1.0`` will use FSR2 at native resolution as a TAA solution.
- .. _class_RenderingServer_constant_VIEWPORT_SCALING_3D_MODE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` **VIEWPORT_SCALING_3D_MODE_MAX** = ``3``
- Represents the size of the :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportUpdateMode:
- .. rst-class:: classref-enumeration
- enum **ViewportUpdateMode**:
- .. _class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_DISABLED** = ``0``
- Do not update the viewport's render target.
- .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ONCE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ONCE** = ``1``
- Update the viewport's render target once, then switch to :ref:`VIEWPORT_UPDATE_DISABLED<class_RenderingServer_constant_VIEWPORT_UPDATE_DISABLED>`.
- .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_VISIBLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_VISIBLE** = ``2``
- Update the viewport's render target only when it is visible. This is the default value.
- .. _class_RenderingServer_constant_VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_WHEN_PARENT_VISIBLE** = ``3``
- Update the viewport's render target only when its parent is visible.
- .. _class_RenderingServer_constant_VIEWPORT_UPDATE_ALWAYS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` **VIEWPORT_UPDATE_ALWAYS** = ``4``
- Always update the viewport's render target.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportClearMode:
- .. rst-class:: classref-enumeration
- enum **ViewportClearMode**:
- .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ALWAYS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ALWAYS** = ``0``
- Always clear the viewport's render target before drawing.
- .. _class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_NEVER** = ``1``
- Never clear the viewport's render target.
- .. _class_RenderingServer_constant_VIEWPORT_CLEAR_ONLY_NEXT_FRAME:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = ``2``
- Clear the viewport's render target on the next frame, then switch to :ref:`VIEWPORT_CLEAR_NEVER<class_RenderingServer_constant_VIEWPORT_CLEAR_NEVER>`.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportEnvironmentMode:
- .. rst-class:: classref-enumeration
- enum **ViewportEnvironmentMode**:
- .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_DISABLED** = ``0``
- Disable rendering of 3D environment over 2D canvas.
- .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_ENABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_ENABLED** = ``1``
- Enable rendering of 3D environment over 2D canvas.
- .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_INHERIT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_INHERIT** = ``2``
- 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>`.
- .. _class_RenderingServer_constant_VIEWPORT_ENVIRONMENT_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` **VIEWPORT_ENVIRONMENT_MAX** = ``3``
- Represents the size of the :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportSDFOversize:
- .. rst-class:: classref-enumeration
- enum **ViewportSDFOversize**:
- .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_100_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_100_PERCENT** = ``0``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_120_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_120_PERCENT** = ``1``
- 2D signed distance field covers 20% of the viewport's size outside the viewport on each side (top, right, bottom, left).
- .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_150_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_150_PERCENT** = ``2``
- 2D signed distance field covers 50% of the viewport's size outside the viewport on each side (top, right, bottom, left).
- .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_200_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_200_PERCENT** = ``3``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_SDF_OVERSIZE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` **VIEWPORT_SDF_OVERSIZE_MAX** = ``4``
- Represents the size of the :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportSDFScale:
- .. rst-class:: classref-enumeration
- enum **ViewportSDFScale**:
- .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_100_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_100_PERCENT** = ``0``
- Full resolution 2D signed distance field scale. This has the highest GPU requirements.
- .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_50_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_50_PERCENT** = ``1``
- Half resolution 2D signed distance field scale on each axis (25% of the viewport pixel count).
- .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_25_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_25_PERCENT** = ``2``
- Quarter resolution 2D signed distance field scale on each axis (6.25% of the viewport pixel count). This has the lowest GPU requirements.
- .. _class_RenderingServer_constant_VIEWPORT_SDF_SCALE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` **VIEWPORT_SDF_SCALE_MAX** = ``3``
- Represents the size of the :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportMSAA:
- .. rst-class:: classref-enumeration
- enum **ViewportMSAA**:
- .. _class_RenderingServer_constant_VIEWPORT_MSAA_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_DISABLED** = ``0``
- Multisample antialiasing for 3D is disabled. This is the default value, and also the fastest setting.
- .. _class_RenderingServer_constant_VIEWPORT_MSAA_2X:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_2X** = ``1``
- Multisample antialiasing uses 2 samples per pixel for 3D. This has a moderate impact on performance.
- .. _class_RenderingServer_constant_VIEWPORT_MSAA_4X:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_4X** = ``2``
- Multisample antialiasing uses 4 samples per pixel for 3D. This has a high impact on performance.
- .. _class_RenderingServer_constant_VIEWPORT_MSAA_8X:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_8X** = ``3``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_MSAA_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` **VIEWPORT_MSAA_MAX** = ``4``
- Represents the size of the :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportScreenSpaceAA:
- .. rst-class:: classref-enumeration
- enum **ViewportScreenSpaceAA**:
- .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_DISABLED** = ``0``
- Do not perform any antialiasing in the full screen post-process.
- .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_FXAA:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_FXAA** = ``1``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_SCREEN_SPACE_AA_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` **VIEWPORT_SCREEN_SPACE_AA_MAX** = ``2``
- Represents the size of the :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportOcclusionCullingBuildQuality:
- .. rst-class:: classref-enumeration
- enum **ViewportOcclusionCullingBuildQuality**:
- .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_LOW** = ``0``
- Low occlusion culling BVH build quality (as defined by Embree). Results in the lowest CPU usage, but least effective culling.
- .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_MEDIUM** = ``1``
- Medium occlusion culling BVH build quality (as defined by Embree).
- .. _class_RenderingServer_constant_VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` **VIEWPORT_OCCLUSION_BUILD_QUALITY_HIGH** = ``2``
- High occlusion culling BVH build quality (as defined by Embree). Results in the highest CPU usage, but most effective culling.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportRenderInfo:
- .. rst-class:: classref-enumeration
- enum **ViewportRenderInfo**:
- .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = ``0``
- Number of objects drawn in a single frame.
- .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_PRIMITIVES_IN_FRAME** = ``1``
- Number of points, lines, or triangles drawn in a single frame.
- .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = ``2``
- Number of draw calls during this frame.
- .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` **VIEWPORT_RENDER_INFO_MAX** = ``3``
- Represents the size of the :ref:`ViewportRenderInfo<enum_RenderingServer_ViewportRenderInfo>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportRenderInfoType:
- .. rst-class:: classref-enumeration
- enum **ViewportRenderInfoType**:
- .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_VISIBLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_VISIBLE** = ``0``
- Visible render pass (excluding shadows).
- .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_SHADOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_SHADOW** = ``1``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_RENDER_INFO_TYPE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` **VIEWPORT_RENDER_INFO_TYPE_MAX** = ``2``
- Represents the size of the :ref:`ViewportRenderInfoType<enum_RenderingServer_ViewportRenderInfoType>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportDebugDraw:
- .. rst-class:: classref-enumeration
- enum **ViewportDebugDraw**:
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLED** = ``0``
- Debug draw is disabled. Default setting.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_UNSHADED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_UNSHADED** = ``1``
- Objects are displayed without light information.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_LIGHTING:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_LIGHTING** = ``2``
- Objects are displayed with only light information.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OVERDRAW:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OVERDRAW** = ``3``
- 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.
- \ **Note:** When using this debug draw mode, custom shaders will be ignored. This means vertex displacement won't be visible anymore.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_WIREFRAME:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_WIREFRAME** = ``4``
- Debug draw draws objects in wireframe.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_NORMAL_BUFFER** = ``5``
- Normal buffer is drawn instead of regular scene so you can see the per-pixel normals that will be used by post-processing effects.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_ALBEDO** = ``6``
- Objects are displayed with only the albedo value from :ref:`VoxelGI<class_VoxelGI>`\ s.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_LIGHTING** = ``7``
- Objects are displayed with only the lighting value from :ref:`VoxelGI<class_VoxelGI>`\ s.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_VOXEL_GI_EMISSION** = ``8``
- Objects are displayed with only the emission color from :ref:`VoxelGI<class_VoxelGI>`\ s.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SHADOW_ATLAS** = ``9``
- 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>`.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DIRECTIONAL_SHADOW_ATLAS** = ``10``
- Draws the shadow atlas that stores shadows from :ref:`DirectionalLight3D<class_DirectionalLight3D>`\ s in the upper left quadrant of the :ref:`Viewport<class_Viewport>`.
- 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.
- The last cascade shows all frustum slices to illustrate the coverage of all slices.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SCENE_LUMINANCE** = ``11``
- Draws the estimated scene luminance. This is a 1×1 texture that is generated when autoexposure is enabled to control the scene's exposure.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSAO:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSAO** = ``12``
- 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>`.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SSIL:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SSIL** = ``13``
- 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>`.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_PSSM_SPLITS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_PSSM_SPLITS** = ``14``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DECAL_ATLAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DECAL_ATLAS** = ``15``
- Draws the decal atlas that stores decal textures from :ref:`Decal<class_Decal>`\ s.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI** = ``16``
- Draws SDFGI cascade data. This is the data structure that is used to bounce lighting against and create reflections.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_SDFGI_PROBES:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_SDFGI_PROBES** = ``17``
- Draws SDFGI probe data. This is the data structure that is used to give indirect lighting dynamic objects moving within the scene.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_GI_BUFFER:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_GI_BUFFER** = ``18``
- Draws the global illumination buffer (:ref:`VoxelGI<class_VoxelGI>` or SDFGI).
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_DISABLE_LOD:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_DISABLE_LOD** = ``19``
- Disable mesh LOD. All meshes are drawn with full detail, which can be used to compare performance.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_OMNI_LIGHTS** = ``20``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_SPOT_LIGHTS** = ``21``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_DECALS** = ``22``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_CLUSTER_REFLECTION_PROBES** = ``23``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_OCCLUDERS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_OCCLUDERS** = ``24``
- 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.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_MOTION_VECTORS:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_MOTION_VECTORS** = ``25``
- Draws the motion vectors buffer. This is used by temporal antialiasing to correct for motion that occurs during gameplay.
- .. _class_RenderingServer_constant_VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` **VIEWPORT_DEBUG_DRAW_INTERNAL_BUFFER** = ``26``
- Internal buffer is drawn instead of regular scene so you can see the per-pixel output that will be used by post-processing effects.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ViewportVRSMode:
- .. rst-class:: classref-enumeration
- enum **ViewportVRSMode**:
- .. _class_RenderingServer_constant_VIEWPORT_VRS_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_DISABLED** = ``0``
- Variable rate shading is disabled.
- .. _class_RenderingServer_constant_VIEWPORT_VRS_TEXTURE:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_TEXTURE** = ``1``
- Variable rate shading uses a texture. Note, for stereoscopic use a texture atlas with a texture for each view.
- .. _class_RenderingServer_constant_VIEWPORT_VRS_XR:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_XR** = ``2``
- Variable rate shading texture is supplied by the primary :ref:`XRInterface<class_XRInterface>`.
- .. _class_RenderingServer_constant_VIEWPORT_VRS_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` **VIEWPORT_VRS_MAX** = ``3``
- Represents the size of the :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_SkyMode:
- .. rst-class:: classref-enumeration
- enum **SkyMode**:
- .. _class_RenderingServer_constant_SKY_MODE_AUTOMATIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_AUTOMATIC** = ``0``
- 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>`.
- .. _class_RenderingServer_constant_SKY_MODE_QUALITY:
- .. rst-class:: classref-enumeration-constant
- :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_QUALITY** = ``1``
- 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>`.
- .. _class_RenderingServer_constant_SKY_MODE_INCREMENTAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_INCREMENTAL** = ``2``
- 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.
- .. _class_RenderingServer_constant_SKY_MODE_REALTIME:
- .. rst-class:: classref-enumeration-constant
- :ref:`SkyMode<enum_RenderingServer_SkyMode>` **SKY_MODE_REALTIME** = ``3``
- 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>`.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentBG:
- .. rst-class:: classref-enumeration
- enum **EnvironmentBG**:
- .. _class_RenderingServer_constant_ENV_BG_CLEAR_COLOR:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CLEAR_COLOR** = ``0``
- Use the clear color as background.
- .. _class_RenderingServer_constant_ENV_BG_COLOR:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_COLOR** = ``1``
- Use a specified color as the background.
- .. _class_RenderingServer_constant_ENV_BG_SKY:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_SKY** = ``2``
- Use a sky resource for the background.
- .. _class_RenderingServer_constant_ENV_BG_CANVAS:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CANVAS** = ``3``
- Use a specified canvas layer as the background. This can be useful for instantiating a 2D scene in a 3D world.
- .. _class_RenderingServer_constant_ENV_BG_KEEP:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_KEEP** = ``4``
- Do not clear the background, use whatever was rendered last frame as the background.
- .. _class_RenderingServer_constant_ENV_BG_CAMERA_FEED:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_CAMERA_FEED** = ``5``
- Displays a camera feed in the background.
- .. _class_RenderingServer_constant_ENV_BG_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` **ENV_BG_MAX** = ``6``
- Represents the size of the :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentAmbientSource:
- .. rst-class:: classref-enumeration
- enum **EnvironmentAmbientSource**:
- .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_BG:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_BG** = ``0``
- Gather ambient light from whichever source is specified as the background.
- .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_DISABLED** = ``1``
- Disable ambient light.
- .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_COLOR:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_COLOR** = ``2``
- Specify a specific :ref:`Color<class_Color>` for ambient light.
- .. _class_RenderingServer_constant_ENV_AMBIENT_SOURCE_SKY:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentAmbientSource<enum_RenderingServer_EnvironmentAmbientSource>` **ENV_AMBIENT_SOURCE_SKY** = ``3``
- Gather ambient light from the :ref:`Sky<class_Sky>` regardless of what the background is.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentReflectionSource:
- .. rst-class:: classref-enumeration
- enum **EnvironmentReflectionSource**:
- .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_BG:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_BG** = ``0``
- Use the background for reflections.
- .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_DISABLED** = ``1``
- Disable reflections.
- .. _class_RenderingServer_constant_ENV_REFLECTION_SOURCE_SKY:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentReflectionSource<enum_RenderingServer_EnvironmentReflectionSource>` **ENV_REFLECTION_SOURCE_SKY** = ``2``
- Use the :ref:`Sky<class_Sky>` for reflections regardless of what the background is.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentGlowBlendMode:
- .. rst-class:: classref-enumeration
- enum **EnvironmentGlowBlendMode**:
- .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_ADDITIVE:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_ADDITIVE** = ``0``
- Additive glow blending mode. Mostly used for particles, glows (bloom), lens flare, bright sources.
- .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SCREEN:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SCREEN** = ``1``
- Screen glow blending mode. Increases brightness, used frequently with bloom.
- .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_SOFTLIGHT:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_SOFTLIGHT** = ``2``
- Soft light glow blending mode. Modifies contrast, exposes shadows and highlights (vivid bloom).
- .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_REPLACE:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_REPLACE** = ``3``
- 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.
- .. _class_RenderingServer_constant_ENV_GLOW_BLEND_MODE_MIX:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentGlowBlendMode<enum_RenderingServer_EnvironmentGlowBlendMode>` **ENV_GLOW_BLEND_MODE_MIX** = ``4``
- Mixes the glow with the underlying color to avoid increasing brightness as much while still maintaining a glow effect.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentToneMapper:
- .. rst-class:: classref-enumeration
- enum **EnvironmentToneMapper**:
- .. _class_RenderingServer_constant_ENV_TONE_MAPPER_LINEAR:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_LINEAR** = ``0``
- Output color as they came in. This can cause bright lighting to look blown out, with noticeable clipping in the output colors.
- .. _class_RenderingServer_constant_ENV_TONE_MAPPER_REINHARD:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_REINHARD** = ``1``
- 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.
- .. _class_RenderingServer_constant_ENV_TONE_MAPPER_FILMIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_FILMIC** = ``2``
- 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>`.
- .. _class_RenderingServer_constant_ENV_TONE_MAPPER_ACES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentToneMapper<enum_RenderingServer_EnvironmentToneMapper>` **ENV_TONE_MAPPER_ACES** = ``3``
- 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>`.
- \ **Note:** This tonemapping operator is called "ACES Fitted" in Godot 3.x.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentSSRRoughnessQuality:
- .. rst-class:: classref-enumeration
- enum **EnvironmentSSRRoughnessQuality**:
- .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_DISABLED** = ``0``
- 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.
- .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_LOW** = ``1``
- Low quality of roughness filter for screen-space reflections.
- .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_MEDIUM:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_MEDIUM** = ``2``
- Medium quality of roughness filter for screen-space reflections.
- .. _class_RenderingServer_constant_ENV_SSR_ROUGHNESS_QUALITY_HIGH:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` **ENV_SSR_ROUGHNESS_QUALITY_HIGH** = ``3``
- High quality of roughness filter for screen-space reflections. This is the slowest option.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentSSAOQuality:
- .. rst-class:: classref-enumeration
- enum **EnvironmentSSAOQuality**:
- .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_VERY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_VERY_LOW** = ``0``
- Lowest quality of screen-space ambient occlusion.
- .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_LOW** = ``1``
- Low quality screen-space ambient occlusion.
- .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_MEDIUM:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_MEDIUM** = ``2``
- Medium quality screen-space ambient occlusion.
- .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_HIGH:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_HIGH** = ``3``
- High quality screen-space ambient occlusion.
- .. _class_RenderingServer_constant_ENV_SSAO_QUALITY_ULTRA:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSAOQuality<enum_RenderingServer_EnvironmentSSAOQuality>` **ENV_SSAO_QUALITY_ULTRA** = ``4``
- Highest quality screen-space ambient occlusion. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentSSILQuality:
- .. rst-class:: classref-enumeration
- enum **EnvironmentSSILQuality**:
- .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_VERY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_VERY_LOW** = ``0``
- Lowest quality of screen-space indirect lighting.
- .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_LOW** = ``1``
- Low quality screen-space indirect lighting.
- .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_MEDIUM:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_MEDIUM** = ``2``
- High quality screen-space indirect lighting.
- .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_HIGH:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_HIGH** = ``3``
- High quality screen-space indirect lighting.
- .. _class_RenderingServer_constant_ENV_SSIL_QUALITY_ULTRA:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSSILQuality<enum_RenderingServer_EnvironmentSSILQuality>` **ENV_SSIL_QUALITY_ULTRA** = ``4``
- Highest quality screen-space indirect lighting. Uses the adaptive target setting which can be dynamically adjusted to smoothly balance performance and visual quality.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentSDFGIYScale:
- .. rst-class:: classref-enumeration
- enum **EnvironmentSDFGIYScale**:
- .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_50_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_50_PERCENT** = ``0``
- 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.
- .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_75_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_75_PERCENT** = ``1``
- Use 75% scale for SDFGI on the Y (vertical) axis. This is a balance between the 50% and 100% SDFGI Y scales.
- .. _class_RenderingServer_constant_ENV_SDFGI_Y_SCALE_100_PERCENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIYScale<enum_RenderingServer_EnvironmentSDFGIYScale>` **ENV_SDFGI_Y_SCALE_100_PERCENT** = ``2``
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentSDFGIRayCount:
- .. rst-class:: classref-enumeration
- enum **EnvironmentSDFGIRayCount**:
- .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_4:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_4** = ``0``
- Throw 4 rays per frame when converging SDFGI. This has the lowest GPU requirements, but creates the most noisy result.
- .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_8:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_8** = ``1``
- Throw 8 rays per frame when converging SDFGI.
- .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_16:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_16** = ``2``
- Throw 16 rays per frame when converging SDFGI.
- .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_32:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_32** = ``3``
- Throw 32 rays per frame when converging SDFGI.
- .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_64:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_64** = ``4``
- Throw 64 rays per frame when converging SDFGI.
- .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_96:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_96** = ``5``
- Throw 96 rays per frame when converging SDFGI. This has high GPU requirements.
- .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_128:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_128** = ``6``
- Throw 128 rays per frame when converging SDFGI. This has very high GPU requirements, but creates the least noisy result.
- .. _class_RenderingServer_constant_ENV_SDFGI_RAY_COUNT_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` **ENV_SDFGI_RAY_COUNT_MAX** = ``7``
- Represents the size of the :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentSDFGIFramesToConverge:
- .. rst-class:: classref-enumeration
- enum **EnvironmentSDFGIFramesToConverge**:
- .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_5_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_5_FRAMES** = ``0``
- Converge SDFGI over 5 frames. This is the most responsive, but creates the most noisy result with a given ray count.
- .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_10_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_10_FRAMES** = ``1``
- Configure SDFGI to fully converge over 10 frames.
- .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_15_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_15_FRAMES** = ``2``
- Configure SDFGI to fully converge over 15 frames.
- .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_20_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_20_FRAMES** = ``3``
- Configure SDFGI to fully converge over 20 frames.
- .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_25_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_25_FRAMES** = ``4``
- Configure SDFGI to fully converge over 25 frames.
- .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_IN_30_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_IN_30_FRAMES** = ``5``
- Configure SDFGI to fully converge over 30 frames. This is the least responsive, but creates the least noisy result with a given ray count.
- .. _class_RenderingServer_constant_ENV_SDFGI_CONVERGE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` **ENV_SDFGI_CONVERGE_MAX** = ``6``
- Represents the size of the :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight:
- .. rst-class:: classref-enumeration
- enum **EnvironmentSDFGIFramesToUpdateLight**:
- .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_1_FRAME** = ``0``
- Update indirect light from dynamic lights in SDFGI over 1 frame. This is the most responsive, but has the highest GPU requirements.
- .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_2_FRAMES** = ``1``
- Update indirect light from dynamic lights in SDFGI over 2 frames.
- .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_4_FRAMES** = ``2``
- Update indirect light from dynamic lights in SDFGI over 4 frames.
- .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_8_FRAMES** = ``3``
- Update indirect light from dynamic lights in SDFGI over 8 frames.
- .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_IN_16_FRAMES** = ``4``
- Update indirect light from dynamic lights in SDFGI over 16 frames. This is the least responsive, but has the lowest GPU requirements.
- .. _class_RenderingServer_constant_ENV_SDFGI_UPDATE_LIGHT_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` **ENV_SDFGI_UPDATE_LIGHT_MAX** = ``5``
- Represents the size of the :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_SubSurfaceScatteringQuality:
- .. rst-class:: classref-enumeration
- enum **SubSurfaceScatteringQuality**:
- .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_DISABLED** = ``0``
- 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.
- .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_LOW** = ``1``
- Low subsurface scattering quality.
- .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_MEDIUM:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_MEDIUM** = ``2``
- Medium subsurface scattering quality.
- .. _class_RenderingServer_constant_SUB_SURFACE_SCATTERING_QUALITY_HIGH:
- .. rst-class:: classref-enumeration-constant
- :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` **SUB_SURFACE_SCATTERING_QUALITY_HIGH** = ``3``
- High subsurface scattering quality. This has the highest GPU requirements.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_DOFBokehShape:
- .. rst-class:: classref-enumeration
- enum **DOFBokehShape**:
- .. _class_RenderingServer_constant_DOF_BOKEH_BOX:
- .. rst-class:: classref-enumeration-constant
- :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_BOX** = ``0``
- Calculate the DOF blur using a box filter. The fastest option, but results in obvious lines in blur pattern.
- .. _class_RenderingServer_constant_DOF_BOKEH_HEXAGON:
- .. rst-class:: classref-enumeration-constant
- :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_HEXAGON** = ``1``
- Calculates DOF blur using a hexagon shaped filter.
- .. _class_RenderingServer_constant_DOF_BOKEH_CIRCLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` **DOF_BOKEH_CIRCLE** = ``2``
- 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).
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_DOFBlurQuality:
- .. rst-class:: classref-enumeration
- enum **DOFBlurQuality**:
- .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_VERY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_VERY_LOW** = ``0``
- Lowest quality DOF blur. This is the fastest setting, but you may be able to see filtering artifacts.
- .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_LOW:
- .. rst-class:: classref-enumeration-constant
- :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_LOW** = ``1``
- Low quality DOF blur.
- .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_MEDIUM:
- .. rst-class:: classref-enumeration-constant
- :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_MEDIUM** = ``2``
- Medium quality DOF blur.
- .. _class_RenderingServer_constant_DOF_BLUR_QUALITY_HIGH:
- .. rst-class:: classref-enumeration-constant
- :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` **DOF_BLUR_QUALITY_HIGH** = ``3``
- Highest quality DOF blur. Results in the smoothest looking blur by taking the most samples, but is also significantly slower.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_InstanceType:
- .. rst-class:: classref-enumeration
- enum **InstanceType**:
- .. _class_RenderingServer_constant_INSTANCE_NONE:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_NONE** = ``0``
- The instance does not have a type.
- .. _class_RenderingServer_constant_INSTANCE_MESH:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MESH** = ``1``
- The instance is a mesh.
- .. _class_RenderingServer_constant_INSTANCE_MULTIMESH:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MULTIMESH** = ``2``
- The instance is a multimesh.
- .. _class_RenderingServer_constant_INSTANCE_PARTICLES:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES** = ``3``
- The instance is a particle emitter.
- .. _class_RenderingServer_constant_INSTANCE_PARTICLES_COLLISION:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_PARTICLES_COLLISION** = ``4``
- The instance is a GPUParticles collision shape.
- .. _class_RenderingServer_constant_INSTANCE_LIGHT:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHT** = ``5``
- The instance is a light.
- .. _class_RenderingServer_constant_INSTANCE_REFLECTION_PROBE:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_REFLECTION_PROBE** = ``6``
- The instance is a reflection probe.
- .. _class_RenderingServer_constant_INSTANCE_DECAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_DECAL** = ``7``
- The instance is a decal.
- .. _class_RenderingServer_constant_INSTANCE_VOXEL_GI:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VOXEL_GI** = ``8``
- The instance is a VoxelGI.
- .. _class_RenderingServer_constant_INSTANCE_LIGHTMAP:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_LIGHTMAP** = ``9``
- The instance is a lightmap.
- .. _class_RenderingServer_constant_INSTANCE_OCCLUDER:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_OCCLUDER** = ``10``
- The instance is an occlusion culling occluder.
- .. _class_RenderingServer_constant_INSTANCE_VISIBLITY_NOTIFIER:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_VISIBLITY_NOTIFIER** = ``11``
- The instance is a visible on-screen notifier.
- .. _class_RenderingServer_constant_INSTANCE_FOG_VOLUME:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_FOG_VOLUME** = ``12``
- The instance is a fog volume.
- .. _class_RenderingServer_constant_INSTANCE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_MAX** = ``13``
- Represents the size of the :ref:`InstanceType<enum_RenderingServer_InstanceType>` enum.
- .. _class_RenderingServer_constant_INSTANCE_GEOMETRY_MASK:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceType<enum_RenderingServer_InstanceType>` **INSTANCE_GEOMETRY_MASK** = ``14``
- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_InstanceFlags:
- .. rst-class:: classref-enumeration
- enum **InstanceFlags**:
- .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_BAKED_LIGHT:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_BAKED_LIGHT** = ``0``
- Allows the instance to be used in baked lighting.
- .. _class_RenderingServer_constant_INSTANCE_FLAG_USE_DYNAMIC_GI:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_USE_DYNAMIC_GI** = ``1``
- Allows the instance to be used with dynamic global illumination.
- .. _class_RenderingServer_constant_INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_DRAW_NEXT_FRAME_IF_VISIBLE** = ``2``
- When set, manually requests to draw geometry on next frame.
- .. _class_RenderingServer_constant_INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_IGNORE_OCCLUSION_CULLING** = ``3``
- Always draw, even if the instance would be culled by occlusion culling. Does not affect view frustum culling.
- .. _class_RenderingServer_constant_INSTANCE_FLAG_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` **INSTANCE_FLAG_MAX** = ``4``
- Represents the size of the :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_ShadowCastingSetting:
- .. rst-class:: classref-enumeration
- enum **ShadowCastingSetting**:
- .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_OFF:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_OFF** = ``0``
- Disable shadows from this instance.
- .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_ON:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_ON** = ``1``
- Cast shadows from this instance.
- .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_DOUBLE_SIDED:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_DOUBLE_SIDED** = ``2``
- Disable backface culling when rendering the shadow of the object. This is slightly slower but may result in more correct shadows.
- .. _class_RenderingServer_constant_SHADOW_CASTING_SETTING_SHADOWS_ONLY:
- .. rst-class:: classref-enumeration-constant
- :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` **SHADOW_CASTING_SETTING_SHADOWS_ONLY** = ``3``
- Only render the shadows from the object. The object itself will not be drawn.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_VisibilityRangeFadeMode:
- .. rst-class:: classref-enumeration
- enum **VisibilityRangeFadeMode**:
- .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DISABLED** = ``0``
- Disable visibility range fading for the given instance.
- .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_SELF:
- .. rst-class:: classref-enumeration-constant
- :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_SELF** = ``1``
- Fade-out the given instance when it approaches its visibility range limits.
- .. _class_RenderingServer_constant_VISIBILITY_RANGE_FADE_DEPENDENCIES:
- .. rst-class:: classref-enumeration-constant
- :ref:`VisibilityRangeFadeMode<enum_RenderingServer_VisibilityRangeFadeMode>` **VISIBILITY_RANGE_FADE_DEPENDENCIES** = ``2``
- Fade-in the given instance's dependencies when reaching its visibility range limits.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_BakeChannels:
- .. rst-class:: classref-enumeration
- enum **BakeChannels**:
- .. _class_RenderingServer_constant_BAKE_CHANNEL_ALBEDO_ALPHA:
- .. rst-class:: classref-enumeration-constant
- :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ALBEDO_ALPHA** = ``0``
- 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.
- .. _class_RenderingServer_constant_BAKE_CHANNEL_NORMAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_NORMAL** = ``1``
- 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``.
- .. _class_RenderingServer_constant_BAKE_CHANNEL_ORM:
- .. rst-class:: classref-enumeration-constant
- :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_ORM** = ``2``
- 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.
- .. _class_RenderingServer_constant_BAKE_CHANNEL_EMISSION:
- .. rst-class:: classref-enumeration-constant
- :ref:`BakeChannels<enum_RenderingServer_BakeChannels>` **BAKE_CHANNEL_EMISSION** = ``3``
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_CanvasTextureChannel:
- .. rst-class:: classref-enumeration
- enum **CanvasTextureChannel**:
- .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_DIFFUSE:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_DIFFUSE** = ``0``
- Diffuse canvas texture (:ref:`CanvasTexture.diffuse_texture<class_CanvasTexture_property_diffuse_texture>`).
- .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_NORMAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_NORMAL** = ``1``
- Normal map canvas texture (:ref:`CanvasTexture.normal_texture<class_CanvasTexture_property_normal_texture>`).
- .. _class_RenderingServer_constant_CANVAS_TEXTURE_CHANNEL_SPECULAR:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` **CANVAS_TEXTURE_CHANNEL_SPECULAR** = ``2``
- Specular map canvas texture (:ref:`CanvasTexture.specular_texture<class_CanvasTexture_property_specular_texture>`).
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_NinePatchAxisMode:
- .. rst-class:: classref-enumeration
- enum **NinePatchAxisMode**:
- .. _class_RenderingServer_constant_NINE_PATCH_STRETCH:
- .. rst-class:: classref-enumeration-constant
- :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_STRETCH** = ``0``
- The nine patch gets stretched where needed.
- .. _class_RenderingServer_constant_NINE_PATCH_TILE:
- .. rst-class:: classref-enumeration-constant
- :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE** = ``1``
- The nine patch gets filled with tiles where needed.
- .. _class_RenderingServer_constant_NINE_PATCH_TILE_FIT:
- .. rst-class:: classref-enumeration-constant
- :ref:`NinePatchAxisMode<enum_RenderingServer_NinePatchAxisMode>` **NINE_PATCH_TILE_FIT** = ``2``
- The nine patch gets filled with tiles where needed and stretches them a bit if needed.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_CanvasItemTextureFilter:
- .. rst-class:: classref-enumeration
- enum **CanvasItemTextureFilter**:
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_DEFAULT:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_DEFAULT** = ``0``
- Uses the default filter mode for this :ref:`Viewport<class_Viewport>`.
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST** = ``1``
- The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled).
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR** = ``2``
- The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled).
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3``
- The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look pixelated from up close, and smooth from a distance.
- Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4``
- The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look smooth from up close, and smooth from a distance.
- Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5``
- The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
- \ **Note:** This texture filter is rarely useful in 2D projects. :ref:`CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS<class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS>` is usually more appropriate in this case.
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6``
- The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
- \ **Note:** This texture filter is rarely useful in 2D projects. :ref:`CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS<class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS>` is usually more appropriate in this case.
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_FILTER_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` **CANVAS_ITEM_TEXTURE_FILTER_MAX** = ``7``
- Max value for :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_CanvasItemTextureRepeat:
- .. rst-class:: classref-enumeration
- enum **CanvasItemTextureRepeat**:
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DEFAULT** = ``0``
- Uses the default repeat mode for this :ref:`Viewport<class_Viewport>`.
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_DISABLED** = ``1``
- 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.
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_ENABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_ENABLED** = ``2``
- 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.
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MIRROR:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MIRROR** = ``3``
- Flip the texture when repeating so that the edge lines up instead of abruptly changing.
- .. _class_RenderingServer_constant_CANVAS_ITEM_TEXTURE_REPEAT_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` **CANVAS_ITEM_TEXTURE_REPEAT_MAX** = ``4``
- Max value for :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_CanvasGroupMode:
- .. rst-class:: classref-enumeration
- enum **CanvasGroupMode**:
- .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_DISABLED** = ``0``
- Child draws over parent and is not clipped.
- .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_ONLY:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_ONLY** = ``1``
- Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn.
- .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_CLIP_AND_DRAW:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_CLIP_AND_DRAW** = ``2``
- Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area.
- .. _class_RenderingServer_constant_CANVAS_GROUP_MODE_TRANSPARENT:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasGroupMode<enum_RenderingServer_CanvasGroupMode>` **CANVAS_GROUP_MODE_TRANSPARENT** = ``3``
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_CanvasLightMode:
- .. rst-class:: classref-enumeration
- enum **CanvasLightMode**:
- .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_POINT:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_POINT** = ``0``
- 2D point light (see :ref:`PointLight2D<class_PointLight2D>`).
- .. _class_RenderingServer_constant_CANVAS_LIGHT_MODE_DIRECTIONAL:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` **CANVAS_LIGHT_MODE_DIRECTIONAL** = ``1``
- 2D directional (sun/moon) light (see :ref:`DirectionalLight2D<class_DirectionalLight2D>`).
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_CanvasLightBlendMode:
- .. rst-class:: classref-enumeration
- enum **CanvasLightBlendMode**:
- .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_ADD:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_ADD** = ``0``
- Adds light color additive to the canvas.
- .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_SUB:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_SUB** = ``1``
- Adds light color subtractive to the canvas.
- .. _class_RenderingServer_constant_CANVAS_LIGHT_BLEND_MODE_MIX:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` **CANVAS_LIGHT_BLEND_MODE_MIX** = ``2``
- The light adds color depending on transparency.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_CanvasLightShadowFilter:
- .. rst-class:: classref-enumeration
- enum **CanvasLightShadowFilter**:
- .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_NONE:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_NONE** = ``0``
- Do not apply a filter to canvas light shadows.
- .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF5:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF5** = ``1``
- Use PCF5 filtering to filter canvas light shadows.
- .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_PCF13:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_PCF13** = ``2``
- Use PCF13 filtering to filter canvas light shadows.
- .. _class_RenderingServer_constant_CANVAS_LIGHT_FILTER_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` **CANVAS_LIGHT_FILTER_MAX** = ``3``
- Max value of the :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_CanvasOccluderPolygonCullMode:
- .. rst-class:: classref-enumeration
- enum **CanvasOccluderPolygonCullMode**:
- .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_DISABLED:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = ``0``
- Culling of the canvas occluder is disabled.
- .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = ``1``
- Culling of the canvas occluder is clockwise.
- .. _class_RenderingServer_constant_CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE:
- .. rst-class:: classref-enumeration-constant
- :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = ``2``
- Culling of the canvas occluder is counterclockwise.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_GlobalShaderParameterType:
- .. rst-class:: classref-enumeration
- enum **GlobalShaderParameterType**:
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BOOL:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BOOL** = ``0``
- Boolean global shader parameter (``global uniform bool ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC2:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC2** = ``1``
- 2-dimensional boolean vector global shader parameter (``global uniform bvec2 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC3:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC3** = ``2``
- 3-dimensional boolean vector global shader parameter (``global uniform bvec3 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_BVEC4:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_BVEC4** = ``3``
- 4-dimensional boolean vector global shader parameter (``global uniform bvec4 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_INT:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_INT** = ``4``
- Integer global shader parameter (``global uniform int ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC2:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC2** = ``5``
- 2-dimensional integer vector global shader parameter (``global uniform ivec2 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC3:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC3** = ``6``
- 3-dimensional integer vector global shader parameter (``global uniform ivec3 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_IVEC4:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_IVEC4** = ``7``
- 4-dimensional integer vector global shader parameter (``global uniform ivec4 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2I:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2I** = ``8``
- 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.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UINT:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UINT** = ``9``
- Unsigned integer global shader parameter (``global uniform uint ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC2:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC2** = ``10``
- 2-dimensional unsigned integer vector global shader parameter (``global uniform uvec2 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC3:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC3** = ``11``
- 3-dimensional unsigned integer vector global shader parameter (``global uniform uvec3 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_UVEC4:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_UVEC4** = ``12``
- 4-dimensional unsigned integer vector global shader parameter (``global uniform uvec4 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_FLOAT:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_FLOAT** = ``13``
- Single-precision floating-point global shader parameter (``global uniform float ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC2:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC2** = ``14``
- 2-dimensional floating-point vector global shader parameter (``global uniform vec2 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC3:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC3** = ``15``
- 3-dimensional floating-point vector global shader parameter (``global uniform vec3 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_VEC4:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_VEC4** = ``16``
- 4-dimensional floating-point vector global shader parameter (``global uniform vec4 ...``).
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_COLOR:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_COLOR** = ``17``
- 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.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_RECT2:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_RECT2** = ``18``
- 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.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT2:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT2** = ``19``
- 2×2 matrix global shader parameter (``global uniform mat2 ...``). Exposed as a :ref:`PackedInt32Array<class_PackedInt32Array>` in the editor UI.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT3:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT3** = ``20``
- 3×3 matrix global shader parameter (``global uniform mat3 ...``). Exposed as a :ref:`Basis<class_Basis>` in the editor UI.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAT4:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAT4** = ``21``
- 4×4 matrix global shader parameter (``global uniform mat4 ...``). Exposed as a :ref:`Projection<class_Projection>` in the editor UI.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM_2D:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM_2D** = ``22``
- 2-dimensional transform global shader parameter (``global uniform mat2x3 ...``). Exposed as a :ref:`Transform2D<class_Transform2D>` in the editor UI.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_TRANSFORM:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_TRANSFORM** = ``23``
- 3-dimensional transform global shader parameter (``global uniform mat3x4 ...``). Exposed as a :ref:`Transform3D<class_Transform3D>` in the editor UI.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2D:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2D** = ``24``
- 2D sampler global shader parameter (``global uniform sampler2D ...``). Exposed as a :ref:`Texture2D<class_Texture2D>` in the editor UI.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER2DARRAY:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER2DARRAY** = ``25``
- 2D sampler array global shader parameter (``global uniform sampler2DArray ...``). Exposed as a :ref:`Texture2DArray<class_Texture2DArray>` in the editor UI.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLER3D:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLER3D** = ``26``
- 3D sampler global shader parameter (``global uniform sampler3D ...``). Exposed as a :ref:`Texture3D<class_Texture3D>` in the editor UI.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_SAMPLERCUBE:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_SAMPLERCUBE** = ``27``
- Cubemap sampler global shader parameter (``global uniform samplerCube ...``). Exposed as a :ref:`Cubemap<class_Cubemap>` in the editor UI.
- .. _class_RenderingServer_constant_GLOBAL_VAR_TYPE_MAX:
- .. rst-class:: classref-enumeration-constant
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **GLOBAL_VAR_TYPE_MAX** = ``28``
- Represents the size of the :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` enum.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_RenderingInfo:
- .. rst-class:: classref-enumeration
- enum **RenderingInfo**:
- .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME:
- .. rst-class:: classref-enumeration-constant
- :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_OBJECTS_IN_FRAME** = ``0``
- Number of objects rendered in the current 3D scene. This varies depending on camera position and rotation.
- .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME:
- .. rst-class:: classref-enumeration-constant
- :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_PRIMITIVES_IN_FRAME** = ``1``
- Number of points, lines, or triangles rendered in the current 3D scene. This varies depending on camera position and rotation.
- .. _class_RenderingServer_constant_RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME:
- .. rst-class:: classref-enumeration-constant
- :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME** = ``2``
- Number of draw calls performed to render in the current 3D scene. This varies depending on camera position and rotation.
- .. _class_RenderingServer_constant_RENDERING_INFO_TEXTURE_MEM_USED:
- .. rst-class:: classref-enumeration-constant
- :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_TEXTURE_MEM_USED** = ``3``
- Texture memory used (in bytes).
- .. _class_RenderingServer_constant_RENDERING_INFO_BUFFER_MEM_USED:
- .. rst-class:: classref-enumeration-constant
- :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_BUFFER_MEM_USED** = ``4``
- Buffer memory used (in bytes). This includes vertex data, uniform buffers, and many miscellaneous buffer types used internally.
- .. _class_RenderingServer_constant_RENDERING_INFO_VIDEO_MEM_USED:
- .. rst-class:: classref-enumeration-constant
- :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` **RENDERING_INFO_VIDEO_MEM_USED** = ``5``
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _enum_RenderingServer_Features:
- .. rst-class:: classref-enumeration
- enum **Features**:
- .. _class_RenderingServer_constant_FEATURE_SHADERS:
- .. rst-class:: classref-enumeration-constant
- :ref:`Features<enum_RenderingServer_Features>` **FEATURE_SHADERS** = ``0``
- Hardware supports shaders. This enum is currently unused in Godot 3.x.
- .. _class_RenderingServer_constant_FEATURE_MULTITHREADED:
- .. rst-class:: classref-enumeration-constant
- :ref:`Features<enum_RenderingServer_Features>` **FEATURE_MULTITHREADED** = ``1``
- Hardware supports multithreading. This enum is currently unused in Godot 3.x.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Constants
- ---------
- .. _class_RenderingServer_constant_NO_INDEX_ARRAY:
- .. rst-class:: classref-constant
- **NO_INDEX_ARRAY** = ``-1``
- Marks an error that shows that the index array is empty.
- .. _class_RenderingServer_constant_ARRAY_WEIGHTS_SIZE:
- .. rst-class:: classref-constant
- **ARRAY_WEIGHTS_SIZE** = ``4``
- Number of weights/bones per vertex.
- .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MIN:
- .. rst-class:: classref-constant
- **CANVAS_ITEM_Z_MIN** = ``-4096``
- The minimum Z-layer for canvas items.
- .. _class_RenderingServer_constant_CANVAS_ITEM_Z_MAX:
- .. rst-class:: classref-constant
- **CANVAS_ITEM_Z_MAX** = ``4096``
- The maximum Z-layer for canvas items.
- .. _class_RenderingServer_constant_MAX_GLOW_LEVELS:
- .. rst-class:: classref-constant
- **MAX_GLOW_LEVELS** = ``7``
- The maximum number of glow levels that can be used with the glow post-processing effect.
- .. _class_RenderingServer_constant_MAX_CURSORS:
- .. rst-class:: classref-constant
- **MAX_CURSORS** = ``8``
- *Deprecated.* This constant is unused internally.
- .. _class_RenderingServer_constant_MAX_2D_DIRECTIONAL_LIGHTS:
- .. rst-class:: classref-constant
- **MAX_2D_DIRECTIONAL_LIGHTS** = ``8``
- The maximum number of directional lights that can be rendered at a given time in 2D.
- .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MIN:
- .. rst-class:: classref-constant
- **MATERIAL_RENDER_PRIORITY_MIN** = ``-128``
- The minimum renderpriority of all materials.
- .. _class_RenderingServer_constant_MATERIAL_RENDER_PRIORITY_MAX:
- .. rst-class:: classref-constant
- **MATERIAL_RENDER_PRIORITY_MAX** = ``127``
- The maximum renderpriority of all materials.
- .. _class_RenderingServer_constant_ARRAY_CUSTOM_COUNT:
- .. rst-class:: classref-constant
- **ARRAY_CUSTOM_COUNT** = ``4``
- 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>`).
- .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_POSITION:
- .. rst-class:: classref-constant
- **PARTICLES_EMIT_FLAG_POSITION** = ``1``
- .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_ROTATION_SCALE:
- .. rst-class:: classref-constant
- **PARTICLES_EMIT_FLAG_ROTATION_SCALE** = ``2``
- .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_VELOCITY:
- .. rst-class:: classref-constant
- **PARTICLES_EMIT_FLAG_VELOCITY** = ``4``
- .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_COLOR:
- .. rst-class:: classref-constant
- **PARTICLES_EMIT_FLAG_COLOR** = ``8``
- .. _class_RenderingServer_constant_PARTICLES_EMIT_FLAG_CUSTOM:
- .. rst-class:: classref-constant
- **PARTICLES_EMIT_FLAG_CUSTOM** = ``16``
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Property Descriptions
- ---------------------
- .. _class_RenderingServer_property_render_loop_enabled:
- .. rst-class:: classref-property
- :ref:`bool<class_bool>` **render_loop_enabled**
- .. rst-class:: classref-property-setget
- - void **set_render_loop_enabled** **(** :ref:`bool<class_bool>` value **)**
- - :ref:`bool<class_bool>` **is_render_loop_enabled** **(** **)**
- 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.
- .. rst-class:: classref-section-separator
- ----
- .. rst-class:: classref-descriptions-group
- Method Descriptions
- -------------------
- .. _class_RenderingServer_method_bake_render_uv2:
- .. rst-class:: classref-method
- :ref:`Image[]<class_Image>` **bake_render_uv2** **(** :ref:`RID<class_RID>` base, :ref:`RID[]<class_RID>` material_overrides, :ref:`Vector2i<class_Vector2i>` image_size **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_call_on_render_thread:
- .. rst-class:: classref-method
- void **call_on_render_thread** **(** :ref:`Callable<class_Callable>` callable **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_attributes_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **camera_attributes_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`CameraAttributes<class_CameraAttributes>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_attributes_set_auto_exposure:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_attributes_set_dof_blur:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_attributes_set_dof_blur_bokeh_shape:
- .. rst-class:: classref-method
- void **camera_attributes_set_dof_blur_bokeh_shape** **(** :ref:`DOFBokehShape<enum_RenderingServer_DOFBokehShape>` shape **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_attributes_set_dof_blur_quality:
- .. rst-class:: classref-method
- void **camera_attributes_set_dof_blur_quality** **(** :ref:`DOFBlurQuality<enum_RenderingServer_DOFBlurQuality>` quality, :ref:`bool<class_bool>` use_jitter **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_attributes_set_exposure:
- .. rst-class:: classref-method
- void **camera_attributes_set_exposure** **(** :ref:`RID<class_RID>` camera_attributes, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` normalization **)**
- 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.
- The normalization factor can be calculated from exposure value (EV100) as follows:
- ::
- func get_exposure_normalization(float ev100):
- return 1.0 / (pow(2.0, ev100) * 1.2)
- The exposure value can be calculated from aperture (in f-stops), shutter speed (in seconds), and sensitivity (in ISO) as follows:
- ::
- func get_exposure(float aperture, float shutter_speed, float sensitivity):
- return log2((aperture * aperture) / shutterSpeed * (100.0 / sensitivity))
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **camera_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`Camera3D<class_Camera3D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_set_camera_attributes:
- .. rst-class:: classref-method
- void **camera_set_camera_attributes** **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` effects **)**
- Sets the camera_attributes created with :ref:`camera_attributes_create<class_RenderingServer_method_camera_attributes_create>` to the given camera.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_set_cull_mask:
- .. rst-class:: classref-method
- void **camera_set_cull_mask** **(** :ref:`RID<class_RID>` camera, :ref:`int<class_int>` layers **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_set_environment:
- .. rst-class:: classref-method
- void **camera_set_environment** **(** :ref:`RID<class_RID>` camera, :ref:`RID<class_RID>` env **)**
- Sets the environment used by this camera. Equivalent to :ref:`Camera3D.environment<class_Camera3D_property_environment>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_set_frustum:
- .. rst-class:: classref-method
- 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 **)**
- Sets camera to use frustum projection. This mode allows adjusting the ``offset`` argument to create "tilted frustum" effects.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_set_orthogonal:
- .. rst-class:: classref-method
- 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 **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_set_perspective:
- .. rst-class:: classref-method
- 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 **)**
- Sets camera to use perspective projection. Objects on the screen becomes smaller when they are far away.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_set_transform:
- .. rst-class:: classref-method
- void **camera_set_transform** **(** :ref:`RID<class_RID>` camera, :ref:`Transform3D<class_Transform3D>` transform **)**
- Sets :ref:`Transform3D<class_Transform3D>` of camera.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_camera_set_use_vertical_aspect:
- .. rst-class:: classref-method
- void **camera_set_use_vertical_aspect** **(** :ref:`RID<class_RID>` camera, :ref:`bool<class_bool>` enable **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **canvas_create** **(** **)**
- 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.
- 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.
- Canvas has no :ref:`Resource<class_Resource>` or :ref:`Node<class_Node>` equivalent.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_animation_slice:
- .. rst-class:: classref-method
- 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 **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_circle:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_clip_ignore:
- .. rst-class:: classref-method
- void **canvas_item_add_clip_ignore** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` ignore **)**
- If ``ignore`` is ``true``, ignore clipping on items drawn with this canvas item until this is called again with ``ignore`` set to false.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_lcd_texture_rect_region:
- .. rst-class:: classref-method
- 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 **)**
- See also :ref:`CanvasItem.draw_lcd_texture_rect_region<class_CanvasItem_method_draw_lcd_texture_rect_region>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_line:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_mesh:
- .. rst-class:: classref-method
- 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() **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_msdf_texture_rect_region:
- .. rst-class:: classref-method
- 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 **)**
- See also :ref:`CanvasItem.draw_msdf_texture_rect_region<class_CanvasItem_method_draw_msdf_texture_rect_region>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_multiline:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_multimesh:
- .. rst-class:: classref-method
- void **canvas_item_add_multimesh** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` texture=RID() **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_nine_patch:
- .. rst-class:: classref-method
- 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) **)**
- Draws a nine-patch rectangle on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_particles:
- .. rst-class:: classref-method
- void **canvas_item_add_particles** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` texture **)**
- Draws particles on the :ref:`CanvasItem<class_CanvasItem>` pointed to by the ``item`` :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_polygon:
- .. rst-class:: classref-method
- 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() **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_polyline:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_primitive:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_rect:
- .. rst-class:: classref-method
- void **canvas_item_add_rect** **(** :ref:`RID<class_RID>` item, :ref:`Rect2<class_Rect2>` rect, :ref:`Color<class_Color>` color **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_set_transform:
- .. rst-class:: classref-method
- void **canvas_item_add_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
- Sets a :ref:`Transform2D<class_Transform2D>` that will be used to transform subsequent canvas item commands.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_texture_rect:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_texture_rect_region:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_add_triangle_array:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- \ **Note:** ``count`` is unused and can be left unspecified.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_clear:
- .. rst-class:: classref-method
- void **canvas_item_clear** **(** :ref:`RID<class_RID>` item **)**
- Clears the :ref:`CanvasItem<class_CanvasItem>` and removes all commands in it.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **canvas_item_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`CanvasItem<class_CanvasItem>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_canvas_group_mode:
- .. rst-class:: classref-method
- 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 **)**
- 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.
- \ **Note:** The equivalent node functionality is found in :ref:`CanvasGroup<class_CanvasGroup>` and :ref:`CanvasItem.clip_children<class_CanvasItem_property_clip_children>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_clip:
- .. rst-class:: classref-method
- void **canvas_item_set_clip** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` clip **)**
- 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.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_copy_to_backbuffer:
- .. rst-class:: classref-method
- void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_Rect2>` rect **)**
- Sets the :ref:`CanvasItem<class_CanvasItem>` to copy a rect to the backbuffer.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_custom_rect:
- .. rst-class:: classref-method
- 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) **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_default_texture_filter:
- .. rst-class:: classref-method
- void **canvas_item_set_default_texture_filter** **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_default_texture_repeat:
- .. rst-class:: classref-method
- void **canvas_item_set_default_texture_repeat** **(** :ref:`RID<class_RID>` item, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_distance_field_mode:
- .. rst-class:: classref-method
- void **canvas_item_set_distance_field_mode** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
- 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>`__.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_draw_behind_parent:
- .. rst-class:: classref-method
- void **canvas_item_set_draw_behind_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_draw_index:
- .. rst-class:: classref-method
- void **canvas_item_set_draw_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` index **)**
- Sets the index for the :ref:`CanvasItem<class_CanvasItem>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_light_mask:
- .. rst-class:: classref-method
- void **canvas_item_set_light_mask** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` mask **)**
- Sets the light ``mask`` for the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.light_mask<class_CanvasItem_property_light_mask>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_material:
- .. rst-class:: classref-method
- void **canvas_item_set_material** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` material **)**
- Sets a new ``material`` to the canvas item specified by the ``item`` RID. Equivalent to :ref:`CanvasItem.material<class_CanvasItem_property_material>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_modulate:
- .. rst-class:: classref-method
- void **canvas_item_set_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_parent:
- .. rst-class:: classref-method
- void **canvas_item_set_parent** **(** :ref:`RID<class_RID>` item, :ref:`RID<class_RID>` parent **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_self_modulate:
- .. rst-class:: classref-method
- void **canvas_item_set_self_modulate** **(** :ref:`RID<class_RID>` item, :ref:`Color<class_Color>` color **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_sort_children_by_y:
- .. rst-class:: classref-method
- void **canvas_item_set_sort_children_by_y** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_transform:
- .. rst-class:: classref-method
- void **canvas_item_set_transform** **(** :ref:`RID<class_RID>` item, :ref:`Transform2D<class_Transform2D>` transform **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_use_parent_material:
- .. rst-class:: classref-method
- void **canvas_item_set_use_parent_material** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
- Sets if the :ref:`CanvasItem<class_CanvasItem>` uses its parent's material.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_visibility_layer:
- .. rst-class:: classref-method
- void **canvas_item_set_visibility_layer** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` visibility_layer **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_visibility_notifier:
- .. rst-class:: classref-method
- 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 **)**
- 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.
- This method can be used to manually mimic :ref:`VisibleOnScreenNotifier2D<class_VisibleOnScreenNotifier2D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_visible:
- .. rst-class:: classref-method
- void **canvas_item_set_visible** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` visible **)**
- Sets the visibility of the :ref:`CanvasItem<class_CanvasItem>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_z_as_relative_to_parent:
- .. rst-class:: classref-method
- void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID<class_RID>` item, :ref:`bool<class_bool>` enabled **)**
- If this is enabled, the Z index of the parent will be added to the children's Z index.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_item_set_z_index:
- .. rst-class:: classref-method
- void **canvas_item_set_z_index** **(** :ref:`RID<class_RID>` item, :ref:`int<class_int>` z_index **)**
- Sets the :ref:`CanvasItem<class_CanvasItem>`'s Z index, i.e. its draw order (lower indexes are drawn first).
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_attach_to_canvas:
- .. rst-class:: classref-method
- void **canvas_light_attach_to_canvas** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` canvas **)**
- Attaches the canvas light to the canvas. Removes it from its previous canvas.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **canvas_light_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`Light2D<class_Light2D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_occluder_attach_to_canvas:
- .. rst-class:: classref-method
- void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` canvas **)**
- Attaches a light occluder to the canvas. Removes it from its previous canvas.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_occluder_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **canvas_light_occluder_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`LightOccluder2D<class_LightOccluder2D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_occluder_set_as_sdf_collision:
- .. rst-class:: classref-method
- void **canvas_light_occluder_set_as_sdf_collision** **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enable **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_occluder_set_enabled:
- .. rst-class:: classref-method
- void **canvas_light_occluder_set_enabled** **(** :ref:`RID<class_RID>` occluder, :ref:`bool<class_bool>` enabled **)**
- Enables or disables light occluder.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_occluder_set_light_mask:
- .. rst-class:: classref-method
- void **canvas_light_occluder_set_light_mask** **(** :ref:`RID<class_RID>` occluder, :ref:`int<class_int>` mask **)**
- The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_occluder_set_polygon:
- .. rst-class:: classref-method
- void **canvas_light_occluder_set_polygon** **(** :ref:`RID<class_RID>` occluder, :ref:`RID<class_RID>` polygon **)**
- Sets a light occluder's polygon.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_occluder_set_transform:
- .. rst-class:: classref-method
- void **canvas_light_occluder_set_transform** **(** :ref:`RID<class_RID>` occluder, :ref:`Transform2D<class_Transform2D>` transform **)**
- Sets a light occluder's :ref:`Transform2D<class_Transform2D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_blend_mode:
- .. rst-class:: classref-method
- void **canvas_light_set_blend_mode** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightBlendMode<enum_RenderingServer_CanvasLightBlendMode>` mode **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_color:
- .. rst-class:: classref-method
- void **canvas_light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
- Sets the color for a light.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_enabled:
- .. rst-class:: classref-method
- void **canvas_light_set_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
- Enables or disables a canvas light.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_energy:
- .. rst-class:: classref-method
- void **canvas_light_set_energy** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` energy **)**
- Sets a canvas light's energy.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_height:
- .. rst-class:: classref-method
- void **canvas_light_set_height** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` height **)**
- Sets a canvas light's height.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_item_cull_mask:
- .. rst-class:: classref-method
- void **canvas_light_set_item_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
- The light mask. See :ref:`LightOccluder2D<class_LightOccluder2D>` for more information on light masks.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_item_shadow_cull_mask:
- .. rst-class:: classref-method
- void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_layer_range:
- .. rst-class:: classref-method
- void **canvas_light_set_layer_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)**
- The layer range that gets rendered with this light.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_mode:
- .. rst-class:: classref-method
- void **canvas_light_set_mode** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` mode **)**
- The mode of the light, see :ref:`CanvasLightMode<enum_RenderingServer_CanvasLightMode>` constants.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_shadow_color:
- .. rst-class:: classref-method
- void **canvas_light_set_shadow_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
- Sets the color of the canvas light's shadow.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_shadow_enabled:
- .. rst-class:: classref-method
- void **canvas_light_set_shadow_enabled** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
- Enables or disables the canvas light's shadow.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_shadow_filter:
- .. rst-class:: classref-method
- void **canvas_light_set_shadow_filter** **(** :ref:`RID<class_RID>` light, :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` filter **)**
- Sets the canvas light's shadow's filter, see :ref:`CanvasLightShadowFilter<enum_RenderingServer_CanvasLightShadowFilter>` constants.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_shadow_smooth:
- .. rst-class:: classref-method
- void **canvas_light_set_shadow_smooth** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` smooth **)**
- Smoothens the shadow. The lower, the smoother.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_texture:
- .. rst-class:: classref-method
- void **canvas_light_set_texture** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
- Sets the texture to be used by a :ref:`PointLight2D<class_PointLight2D>`. Equivalent to :ref:`PointLight2D.texture<class_PointLight2D_property_texture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_texture_offset:
- .. rst-class:: classref-method
- void **canvas_light_set_texture_offset** **(** :ref:`RID<class_RID>` light, :ref:`Vector2<class_Vector2>` offset **)**
- Sets the offset of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.offset<class_PointLight2D_property_offset>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_texture_scale:
- .. rst-class:: classref-method
- void **canvas_light_set_texture_scale** **(** :ref:`RID<class_RID>` light, :ref:`float<class_float>` scale **)**
- Sets the scale factor of a :ref:`PointLight2D<class_PointLight2D>`'s texture. Equivalent to :ref:`PointLight2D.texture_scale<class_PointLight2D_property_texture_scale>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_transform:
- .. rst-class:: classref-method
- void **canvas_light_set_transform** **(** :ref:`RID<class_RID>` light, :ref:`Transform2D<class_Transform2D>` transform **)**
- Sets the canvas light's :ref:`Transform2D<class_Transform2D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_light_set_z_range:
- .. rst-class:: classref-method
- void **canvas_light_set_z_range** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_occluder_polygon_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **canvas_occluder_polygon_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`OccluderPolygon2D<class_OccluderPolygon2D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_occluder_polygon_set_cull_mode:
- .. rst-class:: classref-method
- void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` mode **)**
- Sets an occluder polygons cull mode. See :ref:`CanvasOccluderPolygonCullMode<enum_RenderingServer_CanvasOccluderPolygonCullMode>` constants.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_occluder_polygon_set_shape:
- .. rst-class:: classref-method
- void **canvas_occluder_polygon_set_shape** **(** :ref:`RID<class_RID>` occluder_polygon, :ref:`PackedVector2Array<class_PackedVector2Array>` shape, :ref:`bool<class_bool>` closed **)**
- Sets the shape of the occluder polygon.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_set_disable_scale:
- .. rst-class:: classref-method
- void **canvas_set_disable_scale** **(** :ref:`bool<class_bool>` disable **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_set_item_mirroring:
- .. rst-class:: classref-method
- void **canvas_set_item_mirroring** **(** :ref:`RID<class_RID>` canvas, :ref:`RID<class_RID>` item, :ref:`Vector2<class_Vector2>` mirroring **)**
- A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2<class_Vector2>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_set_modulate:
- .. rst-class:: classref-method
- void **canvas_set_modulate** **(** :ref:`RID<class_RID>` canvas, :ref:`Color<class_Color>` color **)**
- Modulates all colors in the given canvas.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_set_shadow_texture_size:
- .. rst-class:: classref-method
- void **canvas_set_shadow_texture_size** **(** :ref:`int<class_int>` size **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_texture_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **canvas_texture_create** **(** **)**
- 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.
- 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>`.
- \ **Note:** The equivalent resource is :ref:`CanvasTexture<class_CanvasTexture>` and is only meant to be used in 2D rendering, not 3D.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_texture_set_channel:
- .. rst-class:: classref-method
- void **canvas_texture_set_channel** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasTextureChannel<enum_RenderingServer_CanvasTextureChannel>` channel, :ref:`RID<class_RID>` texture **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_texture_set_shading_parameters:
- .. rst-class:: classref-method
- void **canvas_texture_set_shading_parameters** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`Color<class_Color>` base_color, :ref:`float<class_float>` shininess **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_texture_set_texture_filter:
- .. rst-class:: classref-method
- void **canvas_texture_set_texture_filter** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
- Sets the texture ``filter`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_canvas_texture_set_texture_repeat:
- .. rst-class:: classref-method
- void **canvas_texture_set_texture_repeat** **(** :ref:`RID<class_RID>` canvas_texture, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
- Sets the texture ``repeat`` mode to use for the canvas texture specified by the ``canvas_texture`` RID.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_create_local_rendering_device:
- .. rst-class:: classref-method
- :ref:`RenderingDevice<class_RenderingDevice>` **create_local_rendering_device** **(** **)** |const|
- 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.
- \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_debug_canvas_item_get_rect:
- .. rst-class:: classref-method
- :ref:`Rect2<class_Rect2>` **debug_canvas_item_get_rect** **(** :ref:`RID<class_RID>` item **)**
- Returns the bounding rectangle for a canvas item in local space, as calculated by the renderer. This bound is used internally for culling.
- \ **Warning:** This function is intended for debugging in the editor, and will pass through and return a zero :ref:`Rect2<class_Rect2>` in exported projects.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **decal_create** **(** **)**
- 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.
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`Decal<class_Decal>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_set_albedo_mix:
- .. rst-class:: classref-method
- void **decal_set_albedo_mix** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` albedo_mix **)**
- Sets the ``albedo_mix`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.albedo_mix<class_Decal_property_albedo_mix>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_set_cull_mask:
- .. rst-class:: classref-method
- void **decal_set_cull_mask** **(** :ref:`RID<class_RID>` decal, :ref:`int<class_int>` mask **)**
- Sets the cull ``mask`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.cull_mask<class_Decal_property_cull_mask>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_set_distance_fade:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_set_emission_energy:
- .. rst-class:: classref-method
- void **decal_set_emission_energy** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` energy **)**
- Sets the emission ``energy`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.emission_energy<class_Decal_property_emission_energy>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_set_fade:
- .. rst-class:: classref-method
- void **decal_set_fade** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` above, :ref:`float<class_float>` below **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_set_modulate:
- .. rst-class:: classref-method
- void **decal_set_modulate** **(** :ref:`RID<class_RID>` decal, :ref:`Color<class_Color>` color **)**
- Sets the color multiplier in the decal specified by the ``decal`` RID to ``color``. Equivalent to :ref:`Decal.modulate<class_Decal_property_modulate>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_set_normal_fade:
- .. rst-class:: classref-method
- void **decal_set_normal_fade** **(** :ref:`RID<class_RID>` decal, :ref:`float<class_float>` fade **)**
- Sets the normal ``fade`` in the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.normal_fade<class_Decal_property_normal_fade>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_set_size:
- .. rst-class:: classref-method
- void **decal_set_size** **(** :ref:`RID<class_RID>` decal, :ref:`Vector3<class_Vector3>` size **)**
- Sets the ``size`` of the decal specified by the ``decal`` RID. Equivalent to :ref:`Decal.size<class_Decal_property_size>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decal_set_texture:
- .. rst-class:: classref-method
- void **decal_set_texture** **(** :ref:`RID<class_RID>` decal, :ref:`DecalTexture<enum_RenderingServer_DecalTexture>` type, :ref:`RID<class_RID>` texture **)**
- Sets the ``texture`` in the given texture ``type`` slot for the specified decal. Equivalent to :ref:`Decal.set_texture<class_Decal_method_set_texture>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_decals_set_filter:
- .. rst-class:: classref-method
- void **decals_set_filter** **(** :ref:`DecalFilter<enum_RenderingServer_DecalFilter>` filter **)**
- Sets the texture ``filter`` mode to use when rendering decals. This parameter is global and cannot be set on a per-decal basis.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_directional_light_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **directional_light_create** **(** **)**
- 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.
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`DirectionalLight3D<class_DirectionalLight3D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_directional_shadow_atlas_set_size:
- .. rst-class:: classref-method
- void **directional_shadow_atlas_set_size** **(** :ref:`int<class_int>` size, :ref:`bool<class_bool>` is_16bits **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_directional_soft_shadow_filter_set_quality:
- .. rst-class:: classref-method
- void **directional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_bake_panorama:
- .. rst-class:: classref-method
- :ref:`Image<class_Image>` **environment_bake_panorama** **(** :ref:`RID<class_RID>` environment, :ref:`bool<class_bool>` bake_irradiance, :ref:`Vector2i<class_Vector2i>` size **)**
- 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>`.
- \ **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.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **environment_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`Environment<class_Environment>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_glow_set_use_bicubic_upscale:
- .. rst-class:: classref-method
- void **environment_glow_set_use_bicubic_upscale** **(** :ref:`bool<class_bool>` enable **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_adjustment:
- .. rst-class:: classref-method
- 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 **)**
- Sets the values to be used with the "adjustments" post-process effect. See :ref:`Environment<class_Environment>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_ambient_light:
- .. rst-class:: classref-method
- 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 **)**
- Sets the values to be used for ambient light rendering. See :ref:`Environment<class_Environment>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_background:
- .. rst-class:: classref-method
- void **environment_set_background** **(** :ref:`RID<class_RID>` env, :ref:`EnvironmentBG<enum_RenderingServer_EnvironmentBG>` bg **)**
- Sets the environment's background mode. Equivalent to :ref:`Environment.background_mode<class_Environment_property_background_mode>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_bg_color:
- .. rst-class:: classref-method
- void **environment_set_bg_color** **(** :ref:`RID<class_RID>` env, :ref:`Color<class_Color>` color **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_bg_energy:
- .. rst-class:: classref-method
- void **environment_set_bg_energy** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` multiplier, :ref:`float<class_float>` exposure_value **)**
- Sets the intensity of the background color.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_canvas_max_layer:
- .. rst-class:: classref-method
- void **environment_set_canvas_max_layer** **(** :ref:`RID<class_RID>` env, :ref:`int<class_int>` max_layer **)**
- Sets the maximum layer to use if using Canvas background mode.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_fog:
- .. rst-class:: classref-method
- 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 **)**
- Configures fog for the specified environment RID. See ``fog_*`` properties in :ref:`Environment<class_Environment>` for more information.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_glow:
- .. rst-class:: classref-method
- 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 **)**
- Configures glow for the specified environment RID. See ``glow_*`` properties in :ref:`Environment<class_Environment>` for more information.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_sdfgi:
- .. rst-class:: classref-method
- 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 **)**
- Configures signed distance field global illumination for the specified environment RID. See ``sdfgi_*`` properties in :ref:`Environment<class_Environment>` for more information.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_converge:
- .. rst-class:: classref-method
- void **environment_set_sdfgi_frames_to_converge** **(** :ref:`EnvironmentSDFGIFramesToConverge<enum_RenderingServer_EnvironmentSDFGIFramesToConverge>` frames **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_sdfgi_frames_to_update_light:
- .. rst-class:: classref-method
- void **environment_set_sdfgi_frames_to_update_light** **(** :ref:`EnvironmentSDFGIFramesToUpdateLight<enum_RenderingServer_EnvironmentSDFGIFramesToUpdateLight>` frames **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_sdfgi_ray_count:
- .. rst-class:: classref-method
- void **environment_set_sdfgi_ray_count** **(** :ref:`EnvironmentSDFGIRayCount<enum_RenderingServer_EnvironmentSDFGIRayCount>` ray_count **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_sky:
- .. rst-class:: classref-method
- void **environment_set_sky** **(** :ref:`RID<class_RID>` env, :ref:`RID<class_RID>` sky **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_sky_custom_fov:
- .. rst-class:: classref-method
- void **environment_set_sky_custom_fov** **(** :ref:`RID<class_RID>` env, :ref:`float<class_float>` scale **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_sky_orientation:
- .. rst-class:: classref-method
- void **environment_set_sky_orientation** **(** :ref:`RID<class_RID>` env, :ref:`Basis<class_Basis>` orientation **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_ssao:
- .. rst-class:: classref-method
- 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 **)**
- Sets the variables to be used with the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_ssao_quality:
- .. rst-class:: classref-method
- 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 **)**
- Sets the quality level of the screen-space ambient occlusion (SSAO) post-process effect. See :ref:`Environment<class_Environment>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_ssil_quality:
- .. rst-class:: classref-method
- 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 **)**
- Sets the quality level of the screen-space indirect lighting (SSIL) post-process effect. See :ref:`Environment<class_Environment>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_ssr:
- .. rst-class:: classref-method
- 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 **)**
- Sets the variables to be used with the screen-space reflections (SSR) post-process effect. See :ref:`Environment<class_Environment>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_ssr_roughness_quality:
- .. rst-class:: classref-method
- void **environment_set_ssr_roughness_quality** **(** :ref:`EnvironmentSSRRoughnessQuality<enum_RenderingServer_EnvironmentSSRRoughnessQuality>` quality **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_tonemap:
- .. rst-class:: classref-method
- 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 **)**
- Sets the variables to be used with the "tonemap" post-process effect. See :ref:`Environment<class_Environment>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_volumetric_fog:
- .. rst-class:: classref-method
- 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 **)**
- Sets the variables to be used with the volumetric fog post-process effect. See :ref:`Environment<class_Environment>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_volumetric_fog_filter_active:
- .. rst-class:: classref-method
- void **environment_set_volumetric_fog_filter_active** **(** :ref:`bool<class_bool>` active **)**
- Enables filtering of the volumetric fog scattering buffer. This results in much smoother volumes with very few under-sampling artifacts.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_environment_set_volumetric_fog_volume_size:
- .. rst-class:: classref-method
- void **environment_set_volumetric_fog_volume_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` depth **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_fog_volume_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **fog_volume_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`FogVolume<class_FogVolume>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_fog_volume_set_material:
- .. rst-class:: classref-method
- void **fog_volume_set_material** **(** :ref:`RID<class_RID>` fog_volume, :ref:`RID<class_RID>` material **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_fog_volume_set_shape:
- .. rst-class:: classref-method
- void **fog_volume_set_shape** **(** :ref:`RID<class_RID>` fog_volume, :ref:`FogVolumeShape<enum_RenderingServer_FogVolumeShape>` shape **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_fog_volume_set_size:
- .. rst-class:: classref-method
- void **fog_volume_set_size** **(** :ref:`RID<class_RID>` fog_volume, :ref:`Vector3<class_Vector3>` size **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_force_draw:
- .. rst-class:: classref-method
- void **force_draw** **(** :ref:`bool<class_bool>` swap_buffers=true, :ref:`float<class_float>` frame_step=0.0 **)**
- Forces redrawing of all viewports at once. Must be called from the main thread.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_force_sync:
- .. rst-class:: classref-method
- void **force_sync** **(** **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_free_rid:
- .. rst-class:: classref-method
- void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_default_clear_color:
- .. rst-class:: classref-method
- :ref:`Color<class_Color>` **get_default_clear_color** **(** **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_frame_setup_time_cpu:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **get_frame_setup_time_cpu** **(** **)** |const|
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_rendering_device:
- .. rst-class:: classref-method
- :ref:`RenderingDevice<class_RenderingDevice>` **get_rendering_device** **(** **)** |const|
- Returns the global RenderingDevice.
- \ **Note:** When using the OpenGL backend or when running in headless mode, this function always returns ``null``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_rendering_info:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **get_rendering_info** **(** :ref:`RenderingInfo<enum_RenderingServer_RenderingInfo>` info **)**
- 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.
- \ **Note:** Only 3D rendering is currently taken into account by some of these values, such as the number of draw calls.
- \ **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:
- ::
- func _ready():
- for _i in 2:
- await get_tree().process_frame
-
- print(RenderingServer.get_rendering_info(RENDERING_INFO_TOTAL_DRAW_CALLS_IN_FRAME))
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_shader_parameter_list:
- .. rst-class:: classref-method
- :ref:`Dictionary[]<class_Dictionary>` **get_shader_parameter_list** **(** :ref:`RID<class_RID>` shader **)** |const|
- Returns the parameters of a shader.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_test_cube:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **get_test_cube** **(** **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_test_texture:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **get_test_texture** **(** **)**
- 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>`.
- Example of getting the test texture and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
- ::
- var texture_rid = RenderingServer.get_test_texture()
- var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
- $Sprite2D.texture = texture
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_video_adapter_api_version:
- .. rst-class:: classref-method
- :ref:`String<class_String>` **get_video_adapter_api_version** **(** **)** |const|
- 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>`.
- \ **Note:** When running a headless or server binary, this function returns an empty string.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_video_adapter_name:
- .. rst-class:: classref-method
- :ref:`String<class_String>` **get_video_adapter_name** **(** **)** |const|
- Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2").
- \ **Note:** When running a headless or server binary, this function returns an empty string.
- \ **Note:** On the web platform, some browsers such as Firefox may report a different, fixed GPU name such as "GeForce GTX 980" (regardless of the user's actual GPU model). This is done to make fingerprinting more difficult.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_video_adapter_type:
- .. rst-class:: classref-method
- :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **get_video_adapter_type** **(** **)** |const|
- 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.
- \ **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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_video_adapter_vendor:
- .. rst-class:: classref-method
- :ref:`String<class_String>` **get_video_adapter_vendor** **(** **)** |const|
- Returns the vendor of the video adapter (e.g. "NVIDIA Corporation").
- \ **Note:** When running a headless or server binary, this function returns an empty string.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_get_white_texture:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **get_white_texture** **(** **)**
- 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>`.
- Example of getting the white texture and applying it to a :ref:`Sprite2D<class_Sprite2D>` node:
- ::
- var texture_rid = RenderingServer.get_white_texture()
- var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
- $Sprite2D.texture = texture
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_gi_set_use_half_resolution:
- .. rst-class:: classref-method
- void **gi_set_use_half_resolution** **(** :ref:`bool<class_bool>` half_resolution **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_global_shader_parameter_add:
- .. rst-class:: classref-method
- void **global_shader_parameter_add** **(** :ref:`StringName<class_StringName>` name, :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` type, :ref:`Variant<class_Variant>` default_value **)**
- Creates a new global shader uniform.
- \ **Note:** Global shader parameter names are case-sensitive.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_global_shader_parameter_get:
- .. rst-class:: classref-method
- :ref:`Variant<class_Variant>` **global_shader_parameter_get** **(** :ref:`StringName<class_StringName>` name **)** |const|
- Returns the value of the global shader uniform specified by ``name``.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_global_shader_parameter_get_list:
- .. rst-class:: classref-method
- :ref:`StringName[]<class_StringName>` **global_shader_parameter_get_list** **(** **)** |const|
- Returns the list of global shader uniform names.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_global_shader_parameter_get_type:
- .. rst-class:: classref-method
- :ref:`GlobalShaderParameterType<enum_RenderingServer_GlobalShaderParameterType>` **global_shader_parameter_get_type** **(** :ref:`StringName<class_StringName>` name **)** |const|
- Returns the type associated to the global shader uniform specified by ``name``.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_global_shader_parameter_remove:
- .. rst-class:: classref-method
- void **global_shader_parameter_remove** **(** :ref:`StringName<class_StringName>` name **)**
- Removes the global shader uniform specified by ``name``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_global_shader_parameter_set:
- .. rst-class:: classref-method
- void **global_shader_parameter_set** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
- Sets the global shader uniform ``name`` to ``value``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_global_shader_parameter_set_override:
- .. rst-class:: classref-method
- void **global_shader_parameter_set_override** **(** :ref:`StringName<class_StringName>` name, :ref:`Variant<class_Variant>` value **)**
- Overrides the global shader uniform ``name`` with ``value``. Equivalent to the :ref:`ShaderGlobalsOverride<class_ShaderGlobalsOverride>` node.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_has_changed:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **has_changed** **(** **)** |const|
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_has_feature:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **has_feature** **(** :ref:`Features<enum_RenderingServer_Features>` feature **)** |const|
- Not yet implemented. Always returns ``false``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_has_os_feature:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **has_os_feature** **(** :ref:`String<class_String>` feature **)** |const|
- Returns ``true`` if the OS supports a certain ``feature``. Features might be ``s3tc``, ``etc``, and ``etc2``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_attach_object_instance_id:
- .. rst-class:: classref-method
- void **instance_attach_object_instance_id** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` id **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_attach_skeleton:
- .. rst-class:: classref-method
- void **instance_attach_skeleton** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` skeleton **)**
- Attaches a skeleton to an instance. Removes the previous skeleton from the instance.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **instance_create** **(** **)**
- 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.
- 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.
- 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>`.
- \ **Note:** The equivalent node is :ref:`VisualInstance3D<class_VisualInstance3D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_create2:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **instance_create2** **(** :ref:`RID<class_RID>` base, :ref:`RID<class_RID>` scenario **)**
- 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.
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter:
- .. rst-class:: classref-method
- :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const|
- 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>`.
- \ **Note:** Per-instance shader parameter names are case-sensitive.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_default_value:
- .. rst-class:: classref-method
- :ref:`Variant<class_Variant>` **instance_geometry_get_shader_parameter_default_value** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter **)** |const|
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_get_shader_parameter_list:
- .. rst-class:: classref-method
- :ref:`Dictionary[]<class_Dictionary>` **instance_geometry_get_shader_parameter_list** **(** :ref:`RID<class_RID>` instance **)** |const|
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_set_cast_shadows_setting:
- .. rst-class:: classref-method
- void **instance_geometry_set_cast_shadows_setting** **(** :ref:`RID<class_RID>` instance, :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>` shadow_casting_setting **)**
- Sets the shadow casting setting to one of :ref:`ShadowCastingSetting<enum_RenderingServer_ShadowCastingSetting>`. Equivalent to :ref:`GeometryInstance3D.cast_shadow<class_GeometryInstance3D_property_cast_shadow>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_set_flag:
- .. rst-class:: classref-method
- void **instance_geometry_set_flag** **(** :ref:`RID<class_RID>` instance, :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` flag, :ref:`bool<class_bool>` enabled **)**
- Sets the flag for a given :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>`. See :ref:`InstanceFlags<enum_RenderingServer_InstanceFlags>` for more details.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_set_lightmap:
- .. rst-class:: classref-method
- 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 **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_set_lod_bias:
- .. rst-class:: classref-method
- void **instance_geometry_set_lod_bias** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` lod_bias **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_set_material_overlay:
- .. rst-class:: classref-method
- void **instance_geometry_set_material_overlay** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_set_material_override:
- .. rst-class:: classref-method
- void **instance_geometry_set_material_override** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` material **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_set_shader_parameter:
- .. rst-class:: classref-method
- void **instance_geometry_set_shader_parameter** **(** :ref:`RID<class_RID>` instance, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_set_transparency:
- .. rst-class:: classref-method
- void **instance_geometry_set_transparency** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` transparency **)**
- Sets the transparency for the given geometry instance. Equivalent to :ref:`GeometryInstance3D.transparency<class_GeometryInstance3D_property_transparency>`.
- 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.
- In spatial shaders, ``1.0 - transparency`` is set as the default value of the ``ALPHA`` built-in.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_geometry_set_visibility_range:
- .. rst-class:: classref-method
- 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 **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_base:
- .. rst-class:: classref-method
- void **instance_set_base** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` base **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_blend_shape_weight:
- .. rst-class:: classref-method
- void **instance_set_blend_shape_weight** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` shape, :ref:`float<class_float>` weight **)**
- Sets the weight for a given blend shape associated with this instance.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_custom_aabb:
- .. rst-class:: classref-method
- void **instance_set_custom_aabb** **(** :ref:`RID<class_RID>` instance, :ref:`AABB<class_AABB>` aabb **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_extra_visibility_margin:
- .. rst-class:: classref-method
- void **instance_set_extra_visibility_margin** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` margin **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_ignore_culling:
- .. rst-class:: classref-method
- void **instance_set_ignore_culling** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` enabled **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_layer_mask:
- .. rst-class:: classref-method
- void **instance_set_layer_mask** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` mask **)**
- Sets the render layers that this instance will be drawn to. Equivalent to :ref:`VisualInstance3D.layers<class_VisualInstance3D_property_layers>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_pivot_data:
- .. rst-class:: classref-method
- void **instance_set_pivot_data** **(** :ref:`RID<class_RID>` instance, :ref:`float<class_float>` sorting_offset, :ref:`bool<class_bool>` use_aabb_center **)**
- Sets the sorting offset and switches between using the bounding box or instance origin for depth sorting.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_scenario:
- .. rst-class:: classref-method
- void **instance_set_scenario** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` scenario **)**
- Sets the scenario that the instance is in. The scenario is the 3D world that the objects will be displayed in.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_surface_override_material:
- .. rst-class:: classref-method
- void **instance_set_surface_override_material** **(** :ref:`RID<class_RID>` instance, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
- Sets the override material of a specific surface. Equivalent to :ref:`MeshInstance3D.set_surface_override_material<class_MeshInstance3D_method_set_surface_override_material>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_transform:
- .. rst-class:: classref-method
- void **instance_set_transform** **(** :ref:`RID<class_RID>` instance, :ref:`Transform3D<class_Transform3D>` transform **)**
- Sets the world space transform of the instance. Equivalent to :ref:`Node3D.global_transform<class_Node3D_property_global_transform>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_visibility_parent:
- .. rst-class:: classref-method
- void **instance_set_visibility_parent** **(** :ref:`RID<class_RID>` instance, :ref:`RID<class_RID>` parent **)**
- Sets the visibility parent for the given instance. Equivalent to :ref:`Node3D.visibility_parent<class_Node3D_property_visibility_parent>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instance_set_visible:
- .. rst-class:: classref-method
- void **instance_set_visible** **(** :ref:`RID<class_RID>` instance, :ref:`bool<class_bool>` visible **)**
- Sets whether an instance is drawn or not. Equivalent to :ref:`Node3D.visible<class_Node3D_property_visible>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instances_cull_aabb:
- .. rst-class:: classref-method
- :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_aabb** **(** :ref:`AABB<class_AABB>` aabb, :ref:`RID<class_RID>` scenario=RID() **)** |const|
- 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.
- \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instances_cull_convex:
- .. rst-class:: classref-method
- :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_convex** **(** :ref:`Plane[]<class_Plane>` convex, :ref:`RID<class_RID>` scenario=RID() **)** |const|
- 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.
- \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_instances_cull_ray:
- .. rst-class:: classref-method
- :ref:`PackedInt64Array<class_PackedInt64Array>` **instances_cull_ray** **(** :ref:`Vector3<class_Vector3>` from, :ref:`Vector3<class_Vector3>` to, :ref:`RID<class_RID>` scenario=RID() **)** |const|
- 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.
- \ **Warning:** This function is primarily intended for editor usage. For in-game use cases, prefer physics collision.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_directional_set_blend_splits:
- .. rst-class:: classref-method
- void **light_directional_set_blend_splits** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_directional_set_shadow_mode:
- .. rst-class:: classref-method
- void **light_directional_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalShadowMode<enum_RenderingServer_LightDirectionalShadowMode>` mode **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_directional_set_sky_mode:
- .. rst-class:: classref-method
- void **light_directional_set_sky_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightDirectionalSkyMode<enum_RenderingServer_LightDirectionalSkyMode>` mode **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_omni_set_shadow_mode:
- .. rst-class:: classref-method
- void **light_omni_set_shadow_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightOmniShadowMode<enum_RenderingServer_LightOmniShadowMode>` mode **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_projectors_set_filter:
- .. rst-class:: classref-method
- void **light_projectors_set_filter** **(** :ref:`LightProjectorFilter<enum_RenderingServer_LightProjectorFilter>` filter **)**
- Sets the texture filter mode to use when rendering light projectors. This parameter is global and cannot be set on a per-light basis.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_bake_mode:
- .. rst-class:: classref-method
- void **light_set_bake_mode** **(** :ref:`RID<class_RID>` light, :ref:`LightBakeMode<enum_RenderingServer_LightBakeMode>` bake_mode **)**
- Sets the bake mode to use for the specified 3D light. Equivalent to :ref:`Light3D.light_bake_mode<class_Light3D_property_light_bake_mode>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_color:
- .. rst-class:: classref-method
- void **light_set_color** **(** :ref:`RID<class_RID>` light, :ref:`Color<class_Color>` color **)**
- Sets the color of the light. Equivalent to :ref:`Light3D.light_color<class_Light3D_property_light_color>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_cull_mask:
- .. rst-class:: classref-method
- void **light_set_cull_mask** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` mask **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_distance_fade:
- .. rst-class:: classref-method
- 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 **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_max_sdfgi_cascade:
- .. rst-class:: classref-method
- void **light_set_max_sdfgi_cascade** **(** :ref:`RID<class_RID>` light, :ref:`int<class_int>` cascade **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_negative:
- .. rst-class:: classref-method
- void **light_set_negative** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enable **)**
- If ``true``, the 3D light will subtract light instead of adding light. Equivalent to :ref:`Light3D.light_negative<class_Light3D_property_light_negative>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_param:
- .. rst-class:: classref-method
- void **light_set_param** **(** :ref:`RID<class_RID>` light, :ref:`LightParam<enum_RenderingServer_LightParam>` param, :ref:`float<class_float>` value **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_projector:
- .. rst-class:: classref-method
- void **light_set_projector** **(** :ref:`RID<class_RID>` light, :ref:`RID<class_RID>` texture **)**
- Sets the projector texture to use for the specified 3D light. Equivalent to :ref:`Light3D.light_projector<class_Light3D_property_light_projector>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_reverse_cull_face_mode:
- .. rst-class:: classref-method
- void **light_set_reverse_cull_face_mode** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_light_set_shadow:
- .. rst-class:: classref-method
- void **light_set_shadow** **(** :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` enabled **)**
- If ``true``, light will cast shadows. Equivalent to :ref:`Light3D.shadow_enabled<class_Light3D_property_shadow_enabled>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **lightmap_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`LightmapGI<class_LightmapGI>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_get_probe_capture_bsp_tree:
- .. rst-class:: classref-method
- :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_bsp_tree** **(** :ref:`RID<class_RID>` lightmap **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_get_probe_capture_points:
- .. rst-class:: classref-method
- :ref:`PackedVector3Array<class_PackedVector3Array>` **lightmap_get_probe_capture_points** **(** :ref:`RID<class_RID>` lightmap **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_get_probe_capture_sh:
- .. rst-class:: classref-method
- :ref:`PackedColorArray<class_PackedColorArray>` **lightmap_get_probe_capture_sh** **(** :ref:`RID<class_RID>` lightmap **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_get_probe_capture_tetrahedra:
- .. rst-class:: classref-method
- :ref:`PackedInt32Array<class_PackedInt32Array>` **lightmap_get_probe_capture_tetrahedra** **(** :ref:`RID<class_RID>` lightmap **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_set_baked_exposure_normalization:
- .. rst-class:: classref-method
- void **lightmap_set_baked_exposure_normalization** **(** :ref:`RID<class_RID>` lightmap, :ref:`float<class_float>` baked_exposure **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_set_probe_bounds:
- .. rst-class:: classref-method
- void **lightmap_set_probe_bounds** **(** :ref:`RID<class_RID>` lightmap, :ref:`AABB<class_AABB>` bounds **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_set_probe_capture_data:
- .. rst-class:: classref-method
- 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 **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_set_probe_capture_update_speed:
- .. rst-class:: classref-method
- void **lightmap_set_probe_capture_update_speed** **(** :ref:`float<class_float>` speed **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_set_probe_interior:
- .. rst-class:: classref-method
- void **lightmap_set_probe_interior** **(** :ref:`RID<class_RID>` lightmap, :ref:`bool<class_bool>` interior **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_lightmap_set_textures:
- .. rst-class:: classref-method
- void **lightmap_set_textures** **(** :ref:`RID<class_RID>` lightmap, :ref:`RID<class_RID>` light, :ref:`bool<class_bool>` uses_sh **)**
- 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``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_make_sphere_mesh:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **make_sphere_mesh** **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_material_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **material_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`Material<class_Material>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_material_get_param:
- .. rst-class:: classref-method
- :ref:`Variant<class_Variant>` **material_get_param** **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter **)** |const|
- Returns the value of a certain material's parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_material_set_next_pass:
- .. rst-class:: classref-method
- void **material_set_next_pass** **(** :ref:`RID<class_RID>` material, :ref:`RID<class_RID>` next_material **)**
- Sets an object's next material.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_material_set_param:
- .. rst-class:: classref-method
- void **material_set_param** **(** :ref:`RID<class_RID>` material, :ref:`StringName<class_StringName>` parameter, :ref:`Variant<class_Variant>` value **)**
- Sets a material's parameter.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_material_set_render_priority:
- .. rst-class:: classref-method
- void **material_set_render_priority** **(** :ref:`RID<class_RID>` material, :ref:`int<class_int>` priority **)**
- Sets a material's render priority.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_material_set_shader:
- .. rst-class:: classref-method
- void **material_set_shader** **(** :ref:`RID<class_RID>` shader_material, :ref:`RID<class_RID>` shader **)**
- Sets a shader material's shader.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_add_surface:
- .. rst-class:: classref-method
- void **mesh_add_surface** **(** :ref:`RID<class_RID>` mesh, :ref:`Dictionary<class_Dictionary>` surface **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_add_surface_from_arrays:
- .. rst-class:: classref-method
- 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 **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_clear:
- .. rst-class:: classref-method
- void **mesh_clear** **(** :ref:`RID<class_RID>` mesh **)**
- Removes all surfaces from a mesh.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **mesh_create** **(** **)**
- 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.
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`Mesh<class_Mesh>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_create_from_surfaces:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **mesh_create_from_surfaces** **(** :ref:`Dictionary[]<class_Dictionary>` surfaces, :ref:`int<class_int>` blend_shape_count=0 **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_get_blend_shape_count:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **mesh_get_blend_shape_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
- Returns a mesh's blend shape count.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_get_blend_shape_mode:
- .. rst-class:: classref-method
- :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` **mesh_get_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh **)** |const|
- Returns a mesh's blend shape mode.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_get_custom_aabb:
- .. rst-class:: classref-method
- :ref:`AABB<class_AABB>` **mesh_get_custom_aabb** **(** :ref:`RID<class_RID>` mesh **)** |const|
- Returns a mesh's custom aabb.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_get_surface:
- .. rst-class:: classref-method
- :ref:`Dictionary<class_Dictionary>` **mesh_get_surface** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_get_surface_count:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **mesh_get_surface_count** **(** :ref:`RID<class_RID>` mesh **)** |const|
- Returns a mesh's number of surfaces.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_set_blend_shape_mode:
- .. rst-class:: classref-method
- void **mesh_set_blend_shape_mode** **(** :ref:`RID<class_RID>` mesh, :ref:`BlendShapeMode<enum_RenderingServer_BlendShapeMode>` mode **)**
- Sets a mesh's blend shape mode.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_set_custom_aabb:
- .. rst-class:: classref-method
- void **mesh_set_custom_aabb** **(** :ref:`RID<class_RID>` mesh, :ref:`AABB<class_AABB>` aabb **)**
- Sets a mesh's custom aabb.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_set_shadow_mesh:
- .. rst-class:: classref-method
- void **mesh_set_shadow_mesh** **(** :ref:`RID<class_RID>` mesh, :ref:`RID<class_RID>` shadow_mesh **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_get_arrays:
- .. rst-class:: classref-method
- :ref:`Array<class_Array>` **mesh_surface_get_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
- Returns a mesh's surface's buffer arrays.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_get_blend_shape_arrays:
- .. rst-class:: classref-method
- :ref:`Array[]<class_Array>` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
- Returns a mesh's surface's arrays for blend shapes.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_get_format_attribute_stride:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **mesh_surface_get_format_attribute_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
- Returns the stride of the attribute buffer for a mesh with given ``format``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_get_format_normal_tangent_stride:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **mesh_surface_get_format_normal_tangent_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
- Returns the stride of the combined normals and tangents for a mesh with given ``format``. Note importantly that, while normals and tangents are in the vertex buffer with vertices, they are only interleaved with each other and so have a different stride than vertex positions.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_get_format_offset:
- .. rst-class:: classref-method
- :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|
- Returns the offset of a given attribute by ``array_index`` in the start of its respective buffer.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_get_format_skin_stride:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **mesh_surface_get_format_skin_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
- Returns the stride of the skin buffer for a mesh with given ``format``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_get_format_vertex_stride:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **mesh_surface_get_format_vertex_stride** **(** |bitfield|\<:ref:`ArrayFormat<enum_RenderingServer_ArrayFormat>`\> format, :ref:`int<class_int>` vertex_count **)** |const|
- Returns the stride of the vertex positions for a mesh with given ``format``. Note importantly that vertex positions are stored consecutively and are not interleaved with the other attributes in the vertex buffer (normals and tangents).
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_get_material:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **mesh_surface_get_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface **)** |const|
- Returns a mesh's surface's material.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_set_material:
- .. rst-class:: classref-method
- void **mesh_surface_set_material** **(** :ref:`RID<class_RID>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_RID>` material **)**
- Sets a mesh's surface's material.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_update_attribute_region:
- .. rst-class:: classref-method
- 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 **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_update_skin_region:
- .. rst-class:: classref-method
- 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 **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_mesh_surface_update_vertex_region:
- .. rst-class:: classref-method
- 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 **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_allocate_data:
- .. rst-class:: classref-method
- 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 **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **multimesh_create** **(** **)**
- 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.
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`MultiMesh<class_MultiMesh>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_get_aabb:
- .. rst-class:: classref-method
- :ref:`AABB<class_AABB>` **multimesh_get_aabb** **(** :ref:`RID<class_RID>` multimesh **)** |const|
- Calculates and returns the axis-aligned bounding box that encloses all instances within the multimesh.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_get_buffer:
- .. rst-class:: classref-method
- :ref:`PackedFloat32Array<class_PackedFloat32Array>` **multimesh_get_buffer** **(** :ref:`RID<class_RID>` multimesh **)** |const|
- 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.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_get_instance_count:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **multimesh_get_instance_count** **(** :ref:`RID<class_RID>` multimesh **)** |const|
- Returns the number of instances allocated for this multimesh.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_get_mesh:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **multimesh_get_mesh** **(** :ref:`RID<class_RID>` multimesh **)** |const|
- Returns the RID of the mesh that will be used in drawing this multimesh.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_get_visible_instances:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **multimesh_get_visible_instances** **(** :ref:`RID<class_RID>` multimesh **)** |const|
- Returns the number of visible instances for this multimesh.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_instance_get_color:
- .. rst-class:: classref-method
- :ref:`Color<class_Color>` **multimesh_instance_get_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
- Returns the color by which the specified instance will be modulated.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_instance_get_custom_data:
- .. rst-class:: classref-method
- :ref:`Color<class_Color>` **multimesh_instance_get_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
- Returns the custom data associated with the specified instance.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_instance_get_transform:
- .. rst-class:: classref-method
- :ref:`Transform3D<class_Transform3D>` **multimesh_instance_get_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
- Returns the :ref:`Transform3D<class_Transform3D>` of the specified instance.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_instance_get_transform_2d:
- .. rst-class:: classref-method
- :ref:`Transform2D<class_Transform2D>` **multimesh_instance_get_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index **)** |const|
- Returns the :ref:`Transform2D<class_Transform2D>` of the specified instance. For use when the multimesh is set to use 2D transforms.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_instance_set_color:
- .. rst-class:: classref-method
- void **multimesh_instance_set_color** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)**
- Sets the color by which this instance will be modulated. Equivalent to :ref:`MultiMesh.set_instance_color<class_MultiMesh_method_set_instance_color>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_instance_set_custom_data:
- .. rst-class:: classref-method
- void **multimesh_instance_set_custom_data** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Color<class_Color>` custom_data **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_instance_set_transform:
- .. rst-class:: classref-method
- void **multimesh_instance_set_transform** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform3D<class_Transform3D>` transform **)**
- Sets the :ref:`Transform3D<class_Transform3D>` for this instance. Equivalent to :ref:`MultiMesh.set_instance_transform<class_MultiMesh_method_set_instance_transform>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_instance_set_transform_2d:
- .. rst-class:: classref-method
- void **multimesh_instance_set_transform_2d** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` index, :ref:`Transform2D<class_Transform2D>` transform **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_set_buffer:
- .. rst-class:: classref-method
- void **multimesh_set_buffer** **(** :ref:`RID<class_RID>` multimesh, :ref:`PackedFloat32Array<class_PackedFloat32Array>` buffer **)**
- 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>`.
- The per-instance data size and expected data order is:
- ::
- 2D:
- - Position: 8 floats (8 floats for Transform2D)
- - Position + Vertex color: 12 floats (8 floats for Transform2D, 4 floats for Color)
- - Position + Custom data: 12 floats (8 floats for Transform2D, 4 floats of custom data)
- - Position + Vertex color + Custom data: 16 floats (8 floats for Transform2D, 4 floats for Color, 4 floats of custom data)
- 3D:
- - Position: 12 floats (12 floats for Transform3D)
- - Position + Vertex color: 16 floats (12 floats for Transform3D, 4 floats for Color)
- - Position + Custom data: 16 floats (12 floats for Transform3D, 4 floats of custom data)
- - Position + Vertex color + Custom data: 20 floats (12 floats for Transform3D, 4 floats for Color, 4 floats of custom data)
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_set_mesh:
- .. rst-class:: classref-method
- void **multimesh_set_mesh** **(** :ref:`RID<class_RID>` multimesh, :ref:`RID<class_RID>` mesh **)**
- Sets the mesh to be drawn by the multimesh. Equivalent to :ref:`MultiMesh.mesh<class_MultiMesh_property_mesh>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_multimesh_set_visible_instances:
- .. rst-class:: classref-method
- void **multimesh_set_visible_instances** **(** :ref:`RID<class_RID>` multimesh, :ref:`int<class_int>` visible **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_occluder_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **occluder_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`Occluder3D<class_Occluder3D>` (not to be confused with the :ref:`OccluderInstance3D<class_OccluderInstance3D>` node).
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_occluder_set_mesh:
- .. rst-class:: classref-method
- void **occluder_set_mesh** **(** :ref:`RID<class_RID>` occluder, :ref:`PackedVector3Array<class_PackedVector3Array>` vertices, :ref:`PackedInt32Array<class_PackedInt32Array>` indices **)**
- Sets the mesh data for the given occluder RID, which controls the shape of the occlusion culling that will be performed.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_omni_light_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **omni_light_create** **(** **)**
- 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.
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`OmniLight3D<class_OmniLight3D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **particles_collision_create** **(** **)**
- 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.
- \ **Note:** The equivalent nodes are :ref:`GPUParticlesCollision3D<class_GPUParticlesCollision3D>` and :ref:`GPUParticlesAttractor3D<class_GPUParticlesAttractor3D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_height_field_update:
- .. rst-class:: classref-method
- void **particles_collision_height_field_update** **(** :ref:`RID<class_RID>` particles_collision **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_set_attractor_attenuation:
- .. rst-class:: classref-method
- void **particles_collision_set_attractor_attenuation** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` curve **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_set_attractor_directionality:
- .. rst-class:: classref-method
- void **particles_collision_set_attractor_directionality** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` amount **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_set_attractor_strength:
- .. rst-class:: classref-method
- void **particles_collision_set_attractor_strength** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` strength **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_set_box_extents:
- .. rst-class:: classref-method
- void **particles_collision_set_box_extents** **(** :ref:`RID<class_RID>` particles_collision, :ref:`Vector3<class_Vector3>` extents **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_set_collision_type:
- .. rst-class:: classref-method
- void **particles_collision_set_collision_type** **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionType<enum_RenderingServer_ParticlesCollisionType>` type **)**
- Sets the collision or attractor shape ``type`` for the 3D GPU particles collision or attractor specified by the ``particles_collision`` RID.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_set_cull_mask:
- .. rst-class:: classref-method
- void **particles_collision_set_cull_mask** **(** :ref:`RID<class_RID>` particles_collision, :ref:`int<class_int>` mask **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_set_field_texture:
- .. rst-class:: classref-method
- void **particles_collision_set_field_texture** **(** :ref:`RID<class_RID>` particles_collision, :ref:`RID<class_RID>` texture **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_set_height_field_resolution:
- .. rst-class:: classref-method
- void **particles_collision_set_height_field_resolution** **(** :ref:`RID<class_RID>` particles_collision, :ref:`ParticlesCollisionHeightfieldResolution<enum_RenderingServer_ParticlesCollisionHeightfieldResolution>` resolution **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_collision_set_sphere_radius:
- .. rst-class:: classref-method
- void **particles_collision_set_sphere_radius** **(** :ref:`RID<class_RID>` particles_collision, :ref:`float<class_float>` radius **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **particles_create** **(** **)**
- 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.
- 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.
- 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.
- \ **Note:** The equivalent nodes are :ref:`GPUParticles2D<class_GPUParticles2D>` and :ref:`GPUParticles3D<class_GPUParticles3D>`.
- \ **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).
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_emit:
- .. rst-class:: classref-method
- 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 **)**
- Manually emits particles from the ``particles`` instance.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_get_current_aabb:
- .. rst-class:: classref-method
- :ref:`AABB<class_AABB>` **particles_get_current_aabb** **(** :ref:`RID<class_RID>` particles **)**
- Calculates and returns the axis-aligned bounding box that contains all the particles. Equivalent to :ref:`GPUParticles3D.capture_aabb<class_GPUParticles3D_method_capture_aabb>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_get_emitting:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **particles_get_emitting** **(** :ref:`RID<class_RID>` particles **)**
- Returns ``true`` if particles are currently set to emitting.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_is_inactive:
- .. rst-class:: classref-method
- :ref:`bool<class_bool>` **particles_is_inactive** **(** :ref:`RID<class_RID>` particles **)**
- Returns ``true`` if particles are not emitting and particles are set to inactive.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_request_process:
- .. rst-class:: classref-method
- void **particles_request_process** **(** :ref:`RID<class_RID>` particles **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_restart:
- .. rst-class:: classref-method
- void **particles_restart** **(** :ref:`RID<class_RID>` particles **)**
- Reset the particles on the next update. Equivalent to :ref:`GPUParticles3D.restart<class_GPUParticles3D_method_restart>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_amount:
- .. rst-class:: classref-method
- void **particles_set_amount** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` amount **)**
- Sets the number of particles to be drawn and allocates the memory for them. Equivalent to :ref:`GPUParticles3D.amount<class_GPUParticles3D_property_amount>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_amount_ratio:
- .. rst-class:: classref-method
- void **particles_set_amount_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
- Sets the amount ratio for particles to be emitted. Equivalent to :ref:`GPUParticles3D.amount_ratio<class_GPUParticles3D_property_amount_ratio>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_collision_base_size:
- .. rst-class:: classref-method
- void **particles_set_collision_base_size** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` size **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_custom_aabb:
- .. rst-class:: classref-method
- void **particles_set_custom_aabb** **(** :ref:`RID<class_RID>` particles, :ref:`AABB<class_AABB>` aabb **)**
- Sets a custom axis-aligned bounding box for the particle system. Equivalent to :ref:`GPUParticles3D.visibility_aabb<class_GPUParticles3D_property_visibility_aabb>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_draw_order:
- .. rst-class:: classref-method
- void **particles_set_draw_order** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesDrawOrder<enum_RenderingServer_ParticlesDrawOrder>` order **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_draw_pass_mesh:
- .. rst-class:: classref-method
- void **particles_set_draw_pass_mesh** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` pass, :ref:`RID<class_RID>` mesh **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_draw_passes:
- .. rst-class:: classref-method
- void **particles_set_draw_passes** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` count **)**
- Sets the number of draw passes to use. Equivalent to :ref:`GPUParticles3D.draw_passes<class_GPUParticles3D_property_draw_passes>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_emission_transform:
- .. rst-class:: classref-method
- void **particles_set_emission_transform** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D<class_Transform3D>` transform **)**
- Sets the :ref:`Transform3D<class_Transform3D>` that will be used by the particles when they first emit.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_emitter_velocity:
- .. rst-class:: classref-method
- void **particles_set_emitter_velocity** **(** :ref:`RID<class_RID>` particles, :ref:`Vector3<class_Vector3>` velocity **)**
- Sets the velocity of a particle node, that will be used by :ref:`ParticleProcessMaterial.inherit_velocity_ratio<class_ParticleProcessMaterial_property_inherit_velocity_ratio>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_emitting:
- .. rst-class:: classref-method
- void **particles_set_emitting** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` emitting **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_explosiveness_ratio:
- .. rst-class:: classref-method
- void **particles_set_explosiveness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
- Sets the explosiveness ratio. Equivalent to :ref:`GPUParticles3D.explosiveness<class_GPUParticles3D_property_explosiveness>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_fixed_fps:
- .. rst-class:: classref-method
- void **particles_set_fixed_fps** **(** :ref:`RID<class_RID>` particles, :ref:`int<class_int>` fps **)**
- Sets the frame rate that the particle system rendering will be fixed to. Equivalent to :ref:`GPUParticles3D.fixed_fps<class_GPUParticles3D_property_fixed_fps>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_fractional_delta:
- .. rst-class:: classref-method
- void **particles_set_fractional_delta** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
- If ``true``, uses fractional delta which smooths the movement of the particles. Equivalent to :ref:`GPUParticles3D.fract_delta<class_GPUParticles3D_property_fract_delta>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_interp_to_end:
- .. rst-class:: classref-method
- void **particles_set_interp_to_end** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` factor **)**
- Sets the value that informs a :ref:`ParticleProcessMaterial<class_ParticleProcessMaterial>` to rush all particles towards the end of their lifetime.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_interpolate:
- .. rst-class:: classref-method
- void **particles_set_interpolate** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_lifetime:
- .. rst-class:: classref-method
- void **particles_set_lifetime** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` lifetime **)**
- Sets the lifetime of each particle in the system. Equivalent to :ref:`GPUParticles3D.lifetime<class_GPUParticles3D_property_lifetime>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_mode:
- .. rst-class:: classref-method
- void **particles_set_mode** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesMode<enum_RenderingServer_ParticlesMode>` mode **)**
- Sets whether the GPU particles specified by the ``particles`` RID should be rendered in 2D or 3D according to ``mode``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_one_shot:
- .. rst-class:: classref-method
- void **particles_set_one_shot** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` one_shot **)**
- If ``true``, particles will emit once and then stop. Equivalent to :ref:`GPUParticles3D.one_shot<class_GPUParticles3D_property_one_shot>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_pre_process_time:
- .. rst-class:: classref-method
- void **particles_set_pre_process_time** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` time **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_process_material:
- .. rst-class:: classref-method
- void **particles_set_process_material** **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` material **)**
- Sets the material for processing the particles.
- \ **Note:** This is not the material used to draw the materials. Equivalent to :ref:`GPUParticles3D.process_material<class_GPUParticles3D_property_process_material>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_randomness_ratio:
- .. rst-class:: classref-method
- void **particles_set_randomness_ratio** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` ratio **)**
- Sets the emission randomness ratio. This randomizes the emission of particles within their phase. Equivalent to :ref:`GPUParticles3D.randomness<class_GPUParticles3D_property_randomness>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_speed_scale:
- .. rst-class:: classref-method
- void **particles_set_speed_scale** **(** :ref:`RID<class_RID>` particles, :ref:`float<class_float>` scale **)**
- Sets the speed scale of the particle system. Equivalent to :ref:`GPUParticles3D.speed_scale<class_GPUParticles3D_property_speed_scale>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_subemitter:
- .. rst-class:: classref-method
- void **particles_set_subemitter** **(** :ref:`RID<class_RID>` particles, :ref:`RID<class_RID>` subemitter_particles **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_trail_bind_poses:
- .. rst-class:: classref-method
- void **particles_set_trail_bind_poses** **(** :ref:`RID<class_RID>` particles, :ref:`Transform3D[]<class_Transform3D>` bind_poses **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_trails:
- .. rst-class:: classref-method
- void **particles_set_trails** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable, :ref:`float<class_float>` length_sec **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_transform_align:
- .. rst-class:: classref-method
- void **particles_set_transform_align** **(** :ref:`RID<class_RID>` particles, :ref:`ParticlesTransformAlign<enum_RenderingServer_ParticlesTransformAlign>` align **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_particles_set_use_local_coordinates:
- .. rst-class:: classref-method
- void **particles_set_use_local_coordinates** **(** :ref:`RID<class_RID>` particles, :ref:`bool<class_bool>` enable **)**
- If ``true``, particles use local coordinates. If ``false`` they use global coordinates. Equivalent to :ref:`GPUParticles3D.local_coords<class_GPUParticles3D_property_local_coords>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_positional_soft_shadow_filter_set_quality:
- .. rst-class:: classref-method
- void **positional_soft_shadow_filter_set_quality** **(** :ref:`ShadowQuality<enum_RenderingServer_ShadowQuality>` quality **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **reflection_probe_create** **(** **)**
- 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.
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`ReflectionProbe<class_ReflectionProbe>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_ambient_color:
- .. rst-class:: classref-method
- void **reflection_probe_set_ambient_color** **(** :ref:`RID<class_RID>` probe, :ref:`Color<class_Color>` color **)**
- Sets the reflection probe's custom ambient light color. Equivalent to :ref:`ReflectionProbe.ambient_color<class_ReflectionProbe_property_ambient_color>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_ambient_energy:
- .. rst-class:: classref-method
- void **reflection_probe_set_ambient_energy** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` energy **)**
- Sets the reflection probe's custom ambient light energy. Equivalent to :ref:`ReflectionProbe.ambient_color_energy<class_ReflectionProbe_property_ambient_color_energy>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_ambient_mode:
- .. rst-class:: classref-method
- void **reflection_probe_set_ambient_mode** **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeAmbientMode<enum_RenderingServer_ReflectionProbeAmbientMode>` mode **)**
- Sets the reflection probe's ambient light mode. Equivalent to :ref:`ReflectionProbe.ambient_mode<class_ReflectionProbe_property_ambient_mode>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_as_interior:
- .. rst-class:: classref-method
- void **reflection_probe_set_as_interior** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
- If ``true``, reflections will ignore sky contribution. Equivalent to :ref:`ReflectionProbe.interior<class_ReflectionProbe_property_interior>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_cull_mask:
- .. rst-class:: classref-method
- void **reflection_probe_set_cull_mask** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` layers **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_enable_box_projection:
- .. rst-class:: classref-method
- void **reflection_probe_set_enable_box_projection** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_enable_shadows:
- .. rst-class:: classref-method
- void **reflection_probe_set_enable_shadows** **(** :ref:`RID<class_RID>` probe, :ref:`bool<class_bool>` enable **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_intensity:
- .. rst-class:: classref-method
- void **reflection_probe_set_intensity** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` intensity **)**
- Sets the intensity of the reflection probe. Intensity modulates the strength of the reflection. Equivalent to :ref:`ReflectionProbe.intensity<class_ReflectionProbe_property_intensity>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_max_distance:
- .. rst-class:: classref-method
- void **reflection_probe_set_max_distance** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` distance **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_mesh_lod_threshold:
- .. rst-class:: classref-method
- void **reflection_probe_set_mesh_lod_threshold** **(** :ref:`RID<class_RID>` probe, :ref:`float<class_float>` pixels **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_origin_offset:
- .. rst-class:: classref-method
- void **reflection_probe_set_origin_offset** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` offset **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_resolution:
- .. rst-class:: classref-method
- void **reflection_probe_set_resolution** **(** :ref:`RID<class_RID>` probe, :ref:`int<class_int>` resolution **)**
- 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).
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_size:
- .. rst-class:: classref-method
- void **reflection_probe_set_size** **(** :ref:`RID<class_RID>` probe, :ref:`Vector3<class_Vector3>` size **)**
- Sets the size of the area that the reflection probe will capture. Equivalent to :ref:`ReflectionProbe.size<class_ReflectionProbe_property_size>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_reflection_probe_set_update_mode:
- .. rst-class:: classref-method
- void **reflection_probe_set_update_mode** **(** :ref:`RID<class_RID>` probe, :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` mode **)**
- Sets how often the reflection probe updates. Can either be once or every frame. See :ref:`ReflectionProbeUpdateMode<enum_RenderingServer_ReflectionProbeUpdateMode>` for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_request_frame_drawn_callback:
- .. rst-class:: classref-method
- void **request_frame_drawn_callback** **(** :ref:`Callable<class_Callable>` callable **)**
- Schedules a callback to the given callable after a frame has been drawn.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_scenario_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **scenario_create** **(** **)**
- 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.
- 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.
- The scenario is the 3D world that all the visual instances exist in.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_scenario_set_camera_attributes:
- .. rst-class:: classref-method
- void **scenario_set_camera_attributes** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` effects **)**
- Sets the camera attributes (``effects``) that will be used with this scenario. See also :ref:`CameraAttributes<class_CameraAttributes>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_scenario_set_environment:
- .. rst-class:: classref-method
- void **scenario_set_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
- Sets the environment that will be used with this scenario. See also :ref:`Environment<class_Environment>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_scenario_set_fallback_environment:
- .. rst-class:: classref-method
- void **scenario_set_fallback_environment** **(** :ref:`RID<class_RID>` scenario, :ref:`RID<class_RID>` environment **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_screen_space_roughness_limiter_set_active:
- .. rst-class:: classref-method
- void **screen_space_roughness_limiter_set_active** **(** :ref:`bool<class_bool>` enable, :ref:`float<class_float>` amount, :ref:`float<class_float>` limit **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_set_boot_image:
- .. rst-class:: classref-method
- 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 **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_set_debug_generate_wireframes:
- .. rst-class:: classref-method
- void **set_debug_generate_wireframes** **(** :ref:`bool<class_bool>` generate **)**
- This method is currently unimplemented and does nothing if called with ``generate`` set to ``true``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_set_default_clear_color:
- .. rst-class:: classref-method
- void **set_default_clear_color** **(** :ref:`Color<class_Color>` color **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_shader_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **shader_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`Shader<class_Shader>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_shader_get_code:
- .. rst-class:: classref-method
- :ref:`String<class_String>` **shader_get_code** **(** :ref:`RID<class_RID>` shader **)** |const|
- Returns a shader's source code as a string.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_shader_get_default_texture_parameter:
- .. rst-class:: classref-method
- :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|
- Returns a default texture from a shader searched by name.
- \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_shader_get_parameter_default:
- .. rst-class:: classref-method
- :ref:`Variant<class_Variant>` **shader_get_parameter_default** **(** :ref:`RID<class_RID>` shader, :ref:`StringName<class_StringName>` name **)** |const|
- Returns the default value for the specified shader uniform. This is usually the value written in the shader source code.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_shader_set_code:
- .. rst-class:: classref-method
- void **shader_set_code** **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` code **)**
- Sets the shader's source code (which triggers recompilation after being changed).
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_shader_set_default_texture_parameter:
- .. rst-class:: classref-method
- 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 **)**
- Sets a shader's default texture. Overwrites the texture given by name.
- \ **Note:** If the sampler array is used use ``index`` to access the specified texture.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_shader_set_path_hint:
- .. rst-class:: classref-method
- void **shader_set_path_hint** **(** :ref:`RID<class_RID>` shader, :ref:`String<class_String>` path **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_skeleton_allocate_data:
- .. rst-class:: classref-method
- void **skeleton_allocate_data** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bones, :ref:`bool<class_bool>` is_2d_skeleton=false **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_skeleton_bone_get_transform:
- .. rst-class:: classref-method
- :ref:`Transform3D<class_Transform3D>` **skeleton_bone_get_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
- Returns the :ref:`Transform3D<class_Transform3D>` set for a specific bone of this skeleton.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_skeleton_bone_get_transform_2d:
- .. rst-class:: classref-method
- :ref:`Transform2D<class_Transform2D>` **skeleton_bone_get_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone **)** |const|
- Returns the :ref:`Transform2D<class_Transform2D>` set for a specific bone of this skeleton.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_skeleton_bone_set_transform:
- .. rst-class:: classref-method
- void **skeleton_bone_set_transform** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform3D<class_Transform3D>` transform **)**
- Sets the :ref:`Transform3D<class_Transform3D>` for a specific bone of this skeleton.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_skeleton_bone_set_transform_2d:
- .. rst-class:: classref-method
- void **skeleton_bone_set_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`int<class_int>` bone, :ref:`Transform2D<class_Transform2D>` transform **)**
- Sets the :ref:`Transform2D<class_Transform2D>` for a specific bone of this skeleton.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_skeleton_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **skeleton_create** **(** **)**
- 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.
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_skeleton_get_bone_count:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **skeleton_get_bone_count** **(** :ref:`RID<class_RID>` skeleton **)** |const|
- Returns the number of bones allocated for this skeleton.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_skeleton_set_base_transform_2d:
- .. rst-class:: classref-method
- void **skeleton_set_base_transform_2d** **(** :ref:`RID<class_RID>` skeleton, :ref:`Transform2D<class_Transform2D>` base_transform **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_sky_bake_panorama:
- .. rst-class:: classref-method
- :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 **)**
- 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>`.
- \ **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.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_sky_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **sky_create** **(** **)**
- 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.
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_sky_set_material:
- .. rst-class:: classref-method
- void **sky_set_material** **(** :ref:`RID<class_RID>` sky, :ref:`RID<class_RID>` material **)**
- Sets the material that the sky uses to render the background, ambient and reflection maps.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_sky_set_mode:
- .. rst-class:: classref-method
- void **sky_set_mode** **(** :ref:`RID<class_RID>` sky, :ref:`SkyMode<enum_RenderingServer_SkyMode>` mode **)**
- Sets the process ``mode`` of the sky specified by the ``sky`` RID. Equivalent to :ref:`Sky.process_mode<class_Sky_property_process_mode>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_sky_set_radiance_size:
- .. rst-class:: classref-method
- void **sky_set_radiance_size** **(** :ref:`RID<class_RID>` sky, :ref:`int<class_int>` radiance_size **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_spot_light_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **spot_light_create** **(** **)**
- 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.
- 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.
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_sub_surface_scattering_set_quality:
- .. rst-class:: classref-method
- void **sub_surface_scattering_set_quality** **(** :ref:`SubSurfaceScatteringQuality<enum_RenderingServer_SubSurfaceScatteringQuality>` quality **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_sub_surface_scattering_set_scale:
- .. rst-class:: classref-method
- void **sub_surface_scattering_set_scale** **(** :ref:`float<class_float>` scale, :ref:`float<class_float>` depth_scale **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_2d_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **texture_2d_create** **(** :ref:`Image<class_Image>` image **)**
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`Texture2D<class_Texture2D>`.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_2d_get:
- .. rst-class:: classref-method
- :ref:`Image<class_Image>` **texture_2d_get** **(** :ref:`RID<class_RID>` texture **)** |const|
- Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>`.
- 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:
- ::
- var texture_rid = RenderingServer.get_test_texture()
- var texture = ImageTexture.create_from_image(RenderingServer.texture_2d_get(texture_rid))
- $Sprite2D.texture = texture
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_2d_layer_get:
- .. rst-class:: classref-method
- :ref:`Image<class_Image>` **texture_2d_layer_get** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |const|
- Returns an :ref:`Image<class_Image>` instance from the given ``texture`` :ref:`RID<class_RID>` and ``layer``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_2d_layered_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **texture_2d_layered_create** **(** :ref:`Image[]<class_Image>` layers, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)**
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`TextureLayered<class_TextureLayered>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_2d_layered_placeholder_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **texture_2d_layered_placeholder_create** **(** :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layered_type **)**
- 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>`.
- \ **Note:** The equivalent resource is :ref:`PlaceholderTextureLayered<class_PlaceholderTextureLayered>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_2d_placeholder_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **texture_2d_placeholder_create** **(** **)**
- 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>`\
- 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.
- \ **Note:** The equivalent resource is :ref:`PlaceholderTexture2D<class_PlaceholderTexture2D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_2d_update:
- .. rst-class:: classref-method
- void **texture_2d_update** **(** :ref:`RID<class_RID>` texture, :ref:`Image<class_Image>` image, :ref:`int<class_int>` layer **)**
- 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>`).
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_3d_create:
- .. rst-class:: classref-method
- :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 **)**
- **Note:** The equivalent resource is :ref:`Texture3D<class_Texture3D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_3d_get:
- .. rst-class:: classref-method
- :ref:`Image[]<class_Image>` **texture_3d_get** **(** :ref:`RID<class_RID>` texture **)** |const|
- Returns 3D texture data as an array of :ref:`Image<class_Image>`\ s for the specified texture :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_3d_placeholder_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **texture_3d_placeholder_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent resource is :ref:`PlaceholderTexture3D<class_PlaceholderTexture3D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_3d_update:
- .. rst-class:: classref-method
- void **texture_3d_update** **(** :ref:`RID<class_RID>` texture, :ref:`Image[]<class_Image>` data **)**
- 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.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_get_format:
- .. rst-class:: classref-method
- :ref:`Format<enum_Image_Format>` **texture_get_format** **(** :ref:`RID<class_RID>` texture **)** |const|
- Returns the :ref:`Format<enum_Image_Format>` for the texture.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_get_native_handle:
- .. rst-class:: classref-method
- :ref:`int<class_int>` **texture_get_native_handle** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const|
- Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
- \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan).
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_get_path:
- .. rst-class:: classref-method
- :ref:`String<class_String>` **texture_get_path** **(** :ref:`RID<class_RID>` texture **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_get_rd_texture:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **texture_get_rd_texture** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` srgb=false **)** |const|
- Returns a texture :ref:`RID<class_RID>` that can be used with :ref:`RenderingDevice<class_RenderingDevice>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_proxy_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **texture_proxy_create** **(** :ref:`RID<class_RID>` base **)**
- *Deprecated.* ProxyTexture was removed in Godot 4, so this method does nothing when called and always returns a null :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_proxy_update:
- .. rst-class:: classref-method
- void **texture_proxy_update** **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` proxy_to **)**
- *Deprecated.* ProxyTexture was removed in Godot 4, so this method cannot be used anymore.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_rd_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **texture_rd_create** **(** :ref:`RID<class_RID>` rd_texture, :ref:`TextureLayeredType<enum_RenderingServer_TextureLayeredType>` layer_type=0 **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_replace:
- .. rst-class:: classref-method
- void **texture_replace** **(** :ref:`RID<class_RID>` texture, :ref:`RID<class_RID>` by_texture **)**
- Replaces ``texture``'s texture data by the texture specified by the ``by_texture`` RID, without changing ``texture``'s RID.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_set_force_redraw_if_visible:
- .. rst-class:: classref-method
- void **texture_set_force_redraw_if_visible** **(** :ref:`RID<class_RID>` texture, :ref:`bool<class_bool>` enable **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_set_path:
- .. rst-class:: classref-method
- void **texture_set_path** **(** :ref:`RID<class_RID>` texture, :ref:`String<class_String>` path **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_texture_set_size_override:
- .. rst-class:: classref-method
- void **texture_set_size_override** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_attach_camera:
- .. rst-class:: classref-method
- void **viewport_attach_camera** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` camera **)**
- Sets a viewport's camera.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_attach_canvas:
- .. rst-class:: classref-method
- void **viewport_attach_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
- Sets a viewport's canvas.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_attach_to_screen:
- .. rst-class:: classref-method
- 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 **)**
- 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.
- For example, you can set the root viewport to not render at all with the following code:
- FIXME: The method seems to be non-existent.
- .. tabs::
- .. code-tab:: gdscript
- func _ready():
- get_viewport().set_attach_to_screen_rect(Rect2())
- $Viewport.set_attach_to_screen_rect(Rect2(0, 0, 600, 600))
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **viewport_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`Viewport<class_Viewport>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_get_measured_render_time_cpu:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **viewport_get_measured_render_time_cpu** **(** :ref:`RID<class_RID>` viewport **)** |const|
- 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>`.
- \ **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``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_get_measured_render_time_gpu:
- .. rst-class:: classref-method
- :ref:`float<class_float>` **viewport_get_measured_render_time_gpu** **(** :ref:`RID<class_RID>` viewport **)** |const|
- 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>`.
- \ **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``.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_get_render_info:
- .. rst-class:: classref-method
- :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 **)**
- 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.
- See also :ref:`get_rendering_info<class_RenderingServer_method_get_rendering_info>`, which returns global information across all viewports.
- \ **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:
- ::
- func _ready():
- for _i in 2:
- await get_tree().process_frame
-
- print(
- RenderingServer.viewport_get_render_info(get_viewport().get_viewport_rid(),
- RenderingServer.VIEWPORT_RENDER_INFO_TYPE_VISIBLE,
- RenderingServer.VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME)
- )
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_get_render_target:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **viewport_get_render_target** **(** :ref:`RID<class_RID>` viewport **)** |const|
- Returns the render target for the viewport.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_get_texture:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **viewport_get_texture** **(** :ref:`RID<class_RID>` viewport **)** |const|
- Returns the viewport's last rendered frame.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_remove_canvas:
- .. rst-class:: classref-method
- void **viewport_remove_canvas** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas **)**
- Detaches a viewport from a canvas and vice versa.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_active:
- .. rst-class:: classref-method
- void **viewport_set_active** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` active **)**
- If ``true``, sets the viewport active, else sets it inactive.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_canvas_cull_mask:
- .. rst-class:: classref-method
- void **viewport_set_canvas_cull_mask** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` canvas_cull_mask **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_canvas_stacking:
- .. rst-class:: classref-method
- 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 **)**
- Sets the stacking order for a viewport's canvas.
- \ ``layer`` is the actual canvas layer, while ``sublayer`` specifies the stacking order of the canvas among those in the same layer.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_canvas_transform:
- .. rst-class:: classref-method
- void **viewport_set_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` canvas, :ref:`Transform2D<class_Transform2D>` offset **)**
- Sets the transformation of a viewport's canvas.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_clear_mode:
- .. rst-class:: classref-method
- void **viewport_set_clear_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` clear_mode **)**
- Sets the clear mode of a viewport. See :ref:`ViewportClearMode<enum_RenderingServer_ViewportClearMode>` for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_debug_draw:
- .. rst-class:: classref-method
- void **viewport_set_debug_draw** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` draw **)**
- Sets the debug draw mode of a viewport. See :ref:`ViewportDebugDraw<enum_RenderingServer_ViewportDebugDraw>` for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_filter:
- .. rst-class:: classref-method
- void **viewport_set_default_canvas_item_texture_filter** **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` filter **)**
- Sets the default texture filtering mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureFilter<enum_RenderingServer_CanvasItemTextureFilter>` for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_default_canvas_item_texture_repeat:
- .. rst-class:: classref-method
- void **viewport_set_default_canvas_item_texture_repeat** **(** :ref:`RID<class_RID>` viewport, :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` repeat **)**
- Sets the default texture repeat mode for the specified ``viewport`` RID. See :ref:`CanvasItemTextureRepeat<enum_RenderingServer_CanvasItemTextureRepeat>` for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_disable_2d:
- .. rst-class:: classref-method
- void **viewport_set_disable_2d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)**
- If ``true``, the viewport's canvas (i.e. 2D and GUI elements) is not rendered.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_disable_3d:
- .. rst-class:: classref-method
- void **viewport_set_disable_3d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` disable **)**
- If ``true``, the viewport's 3D elements are not rendered.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_environment_mode:
- .. rst-class:: classref-method
- void **viewport_set_environment_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportEnvironmentMode<enum_RenderingServer_ViewportEnvironmentMode>` mode **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_fsr_sharpness:
- .. rst-class:: classref-method
- void **viewport_set_fsr_sharpness** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` sharpness **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_global_canvas_transform:
- .. rst-class:: classref-method
- void **viewport_set_global_canvas_transform** **(** :ref:`RID<class_RID>` viewport, :ref:`Transform2D<class_Transform2D>` transform **)**
- Sets the viewport's global transformation matrix.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_measure_render_time:
- .. rst-class:: classref-method
- void **viewport_set_measure_render_time** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
- 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``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_msaa_2d:
- .. rst-class:: classref-method
- void **viewport_set_msaa_2d** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)**
- Sets the multisample anti-aliasing mode for 2D/Canvas on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_msaa_3d:
- .. rst-class:: classref-method
- void **viewport_set_msaa_3d** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` msaa **)**
- Sets the multisample anti-aliasing mode for 3D on the specified ``viewport`` RID. See :ref:`ViewportMSAA<enum_RenderingServer_ViewportMSAA>` for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_occlusion_culling_build_quality:
- .. rst-class:: classref-method
- void **viewport_set_occlusion_culling_build_quality** **(** :ref:`ViewportOcclusionCullingBuildQuality<enum_RenderingServer_ViewportOcclusionCullingBuildQuality>` quality **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_occlusion_rays_per_thread:
- .. rst-class:: classref-method
- void **viewport_set_occlusion_rays_per_thread** **(** :ref:`int<class_int>` rays_per_thread **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_parent_viewport:
- .. rst-class:: classref-method
- void **viewport_set_parent_viewport** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` parent_viewport **)**
- Sets the viewport's parent to the viewport specified by the ``parent_viewport`` RID.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_quadrant_subdivision:
- .. rst-class:: classref-method
- void **viewport_set_positional_shadow_atlas_quadrant_subdivision** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_positional_shadow_atlas_size:
- .. rst-class:: classref-method
- 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 **)**
- 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.
- \ **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).
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_render_direct_to_screen:
- .. rst-class:: classref-method
- void **viewport_set_render_direct_to_screen** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_scaling_3d_mode:
- .. rst-class:: classref-method
- void **viewport_set_scaling_3d_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScaling3DMode<enum_RenderingServer_ViewportScaling3DMode>` scaling_3d_mode **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_scaling_3d_scale:
- .. rst-class:: classref-method
- void **viewport_set_scaling_3d_scale** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` scale **)**
- 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.
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_scenario:
- .. rst-class:: classref-method
- void **viewport_set_scenario** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` scenario **)**
- Sets a viewport's scenario. The scenario contains information about environment information, reflection atlas, etc.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_screen_space_aa:
- .. rst-class:: classref-method
- void **viewport_set_screen_space_aa** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportScreenSpaceAA<enum_RenderingServer_ViewportScreenSpaceAA>` mode **)**
- Sets the viewport's screen-space antialiasing mode.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_sdf_oversize_and_scale:
- .. rst-class:: classref-method
- void **viewport_set_sdf_oversize_and_scale** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportSDFOversize<enum_RenderingServer_ViewportSDFOversize>` oversize, :ref:`ViewportSDFScale<enum_RenderingServer_ViewportSDFScale>` scale **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_size:
- .. rst-class:: classref-method
- void **viewport_set_size** **(** :ref:`RID<class_RID>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
- Sets the viewport's width and height in pixels.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_snap_2d_transforms_to_pixel:
- .. rst-class:: classref-method
- void **viewport_set_snap_2d_transforms_to_pixel** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_snap_2d_vertices_to_pixel:
- .. rst-class:: classref-method
- void **viewport_set_snap_2d_vertices_to_pixel** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_texture_mipmap_bias:
- .. rst-class:: classref-method
- void **viewport_set_texture_mipmap_bias** **(** :ref:`RID<class_RID>` viewport, :ref:`float<class_float>` mipmap_bias **)**
- 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.
- \ **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``.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_transparent_background:
- .. rst-class:: classref-method
- void **viewport_set_transparent_background** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
- If ``true``, the viewport renders its background as transparent.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_update_mode:
- .. rst-class:: classref-method
- void **viewport_set_update_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` update_mode **)**
- Sets when the viewport should be updated. See :ref:`ViewportUpdateMode<enum_RenderingServer_ViewportUpdateMode>` constants for options.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_use_debanding:
- .. rst-class:: classref-method
- void **viewport_set_use_debanding** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_use_hdr_2d:
- .. rst-class:: classref-method
- void **viewport_set_use_hdr_2d** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enabled **)**
- 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>`.
- \ **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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_use_occlusion_culling:
- .. rst-class:: classref-method
- void **viewport_set_use_occlusion_culling** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_use_taa:
- .. rst-class:: classref-method
- void **viewport_set_use_taa** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` enable **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_use_xr:
- .. rst-class:: classref-method
- void **viewport_set_use_xr** **(** :ref:`RID<class_RID>` viewport, :ref:`bool<class_bool>` use_xr **)**
- If ``true``, the viewport uses augmented or virtual reality technologies. See :ref:`XRInterface<class_XRInterface>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_vrs_mode:
- .. rst-class:: classref-method
- void **viewport_set_vrs_mode** **(** :ref:`RID<class_RID>` viewport, :ref:`ViewportVRSMode<enum_RenderingServer_ViewportVRSMode>` mode **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_viewport_set_vrs_texture:
- .. rst-class:: classref-method
- void **viewport_set_vrs_texture** **(** :ref:`RID<class_RID>` viewport, :ref:`RID<class_RID>` texture **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_visibility_notifier_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **visibility_notifier_create** **(** **)**
- 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.
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`VisibleOnScreenNotifier3D<class_VisibleOnScreenNotifier3D>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_visibility_notifier_set_aabb:
- .. rst-class:: classref-method
- void **visibility_notifier_set_aabb** **(** :ref:`RID<class_RID>` notifier, :ref:`AABB<class_AABB>` aabb **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_visibility_notifier_set_callbacks:
- .. rst-class:: classref-method
- void **visibility_notifier_set_callbacks** **(** :ref:`RID<class_RID>` notifier, :ref:`Callable<class_Callable>` enter_callable, :ref:`Callable<class_Callable>` exit_callable **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_allocate_data:
- .. rst-class:: classref-method
- 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 **)**
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_create:
- .. rst-class:: classref-method
- :ref:`RID<class_RID>` **voxel_gi_create** **(** **)**
- 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.
- 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.
- \ **Note:** The equivalent node is :ref:`VoxelGI<class_VoxelGI>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_get_data_cells:
- .. rst-class:: classref-method
- :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_data_cells** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_get_distance_field:
- .. rst-class:: classref-method
- :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_distance_field** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_get_level_counts:
- .. rst-class:: classref-method
- :ref:`PackedInt32Array<class_PackedInt32Array>` **voxel_gi_get_level_counts** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_get_octree_cells:
- .. rst-class:: classref-method
- :ref:`PackedByteArray<class_PackedByteArray>` **voxel_gi_get_octree_cells** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_get_octree_size:
- .. rst-class:: classref-method
- :ref:`Vector3i<class_Vector3i>` **voxel_gi_get_octree_size** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_get_to_cell_xform:
- .. rst-class:: classref-method
- :ref:`Transform3D<class_Transform3D>` **voxel_gi_get_to_cell_xform** **(** :ref:`RID<class_RID>` voxel_gi **)** |const|
- .. container:: contribute
- There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_set_baked_exposure_normalization:
- .. rst-class:: classref-method
- void **voxel_gi_set_baked_exposure_normalization** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` baked_exposure **)**
- 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>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_set_bias:
- .. rst-class:: classref-method
- void **voxel_gi_set_bias** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)**
- Sets the :ref:`VoxelGIData.bias<class_VoxelGIData_property_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_set_dynamic_range:
- .. rst-class:: classref-method
- void **voxel_gi_set_dynamic_range** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` range **)**
- Sets the :ref:`VoxelGIData.dynamic_range<class_VoxelGIData_property_dynamic_range>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_set_energy:
- .. rst-class:: classref-method
- void **voxel_gi_set_energy** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` energy **)**
- Sets the :ref:`VoxelGIData.energy<class_VoxelGIData_property_energy>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_set_interior:
- .. rst-class:: classref-method
- void **voxel_gi_set_interior** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)**
- Sets the :ref:`VoxelGIData.interior<class_VoxelGIData_property_interior>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_set_normal_bias:
- .. rst-class:: classref-method
- void **voxel_gi_set_normal_bias** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` bias **)**
- Sets the :ref:`VoxelGIData.normal_bias<class_VoxelGIData_property_normal_bias>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_set_propagation:
- .. rst-class:: classref-method
- void **voxel_gi_set_propagation** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`float<class_float>` amount **)**
- Sets the :ref:`VoxelGIData.propagation<class_VoxelGIData_property_propagation>` value to use on the specified ``voxel_gi``'s :ref:`RID<class_RID>`.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_set_quality:
- .. rst-class:: classref-method
- void **voxel_gi_set_quality** **(** :ref:`VoxelGIQuality<enum_RenderingServer_VoxelGIQuality>` quality **)**
- 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.
- .. rst-class:: classref-item-separator
- ----
- .. _class_RenderingServer_method_voxel_gi_set_use_two_bounces:
- .. rst-class:: classref-method
- void **voxel_gi_set_use_two_bounces** **(** :ref:`RID<class_RID>` voxel_gi, :ref:`bool<class_bool>` enable **)**
- 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>`.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
- .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|