class_renderingdevice.rst 505 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderingDevice.xml.
  6. .. _class_RenderingDevice:
  7. RenderingDevice
  8. ===============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. Abstraction for working with modern low-level graphics APIs.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. **RenderingDevice** is an abstraction for working with modern low-level graphics APIs such as Vulkan. Compared to :ref:`RenderingServer<class_RenderingServer>` (which works with Godot's own rendering subsystems), **RenderingDevice** is much lower-level and allows working more directly with the underlying graphics APIs. **RenderingDevice** is used in Godot to provide support for several modern low-level graphics APIs while reducing the amount of code duplication required. **RenderingDevice** can also be used in your own projects to perform things that are not exposed by :ref:`RenderingServer<class_RenderingServer>` or high-level nodes, such as using compute shaders.
  15. On startup, Godot creates a global **RenderingDevice** which can be retrieved using :ref:`RenderingServer.get_rendering_device<class_RenderingServer_method_get_rendering_device>`. This global **RenderingDevice** performs drawing to the screen.
  16. \ **Local RenderingDevices:** Using :ref:`RenderingServer.create_local_rendering_device<class_RenderingServer_method_create_local_rendering_device>`, you can create "secondary" rendering devices to perform drawing and GPU compute operations on separate threads.
  17. \ **Note:** **RenderingDevice** assumes intermediate knowledge of modern graphics APIs such as Vulkan, Direct3D 12, Metal or WebGPU. These graphics APIs are lower-level than OpenGL or Direct3D 11, requiring you to perform what was previously done by the graphics driver itself. If you have difficulty understanding the concepts used in this class, follow the `Vulkan Tutorial <https://vulkan-tutorial.com/>`__ or `Vulkan Guide <https://vkguide.dev/>`__. It's recommended to have existing modern OpenGL or Direct3D 11 knowledge before attempting to learn a low-level graphics API.
  18. \ **Note:** **RenderingDevice** is not available when running in headless mode or when using the Compatibility rendering method.
  19. .. rst-class:: classref-introduction-group
  20. Tutorials
  21. ---------
  22. - :doc:`Using compute shaders <../tutorials/shaders/compute_shaders>`
  23. .. rst-class:: classref-reftable-group
  24. Methods
  25. -------
  26. .. table::
  27. :widths: auto
  28. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | |void| | :ref:`barrier<class_RenderingDevice_method_barrier>`\ (\ from\: |bitfield|\[:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\] = 32767, to\: |bitfield|\[:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\] = 32767\ ) |
  30. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`buffer_clear<class_RenderingDevice_method_buffer_clear>`\ (\ buffer\: :ref:`RID<class_RID>`, offset\: :ref:`int<class_int>`, size_bytes\: :ref:`int<class_int>`\ ) |
  32. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`buffer_copy<class_RenderingDevice_method_buffer_copy>`\ (\ src_buffer\: :ref:`RID<class_RID>`, dst_buffer\: :ref:`RID<class_RID>`, src_offset\: :ref:`int<class_int>`, dst_offset\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) |
  34. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`buffer_get_data<class_RenderingDevice_method_buffer_get_data>`\ (\ buffer\: :ref:`RID<class_RID>`, offset_bytes\: :ref:`int<class_int>` = 0, size_bytes\: :ref:`int<class_int>` = 0\ ) |
  36. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`buffer_get_data_async<class_RenderingDevice_method_buffer_get_data_async>`\ (\ buffer\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`, offset_bytes\: :ref:`int<class_int>` = 0, size_bytes\: :ref:`int<class_int>` = 0\ ) |
  38. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`int<class_int>` | :ref:`buffer_get_device_address<class_RenderingDevice_method_buffer_get_device_address>`\ (\ buffer\: :ref:`RID<class_RID>`\ ) |
  40. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`buffer_update<class_RenderingDevice_method_buffer_update>`\ (\ buffer\: :ref:`RID<class_RID>`, offset\: :ref:`int<class_int>`, size_bytes\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  42. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | |void| | :ref:`capture_timestamp<class_RenderingDevice_method_capture_timestamp>`\ (\ name\: :ref:`String<class_String>`\ ) |
  44. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | |void| | :ref:`compute_list_add_barrier<class_RenderingDevice_method_compute_list_add_barrier>`\ (\ compute_list\: :ref:`int<class_int>`\ ) |
  46. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | :ref:`int<class_int>` | :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>`\ (\ ) |
  48. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | |void| | :ref:`compute_list_bind_compute_pipeline<class_RenderingDevice_method_compute_list_bind_compute_pipeline>`\ (\ compute_list\: :ref:`int<class_int>`, compute_pipeline\: :ref:`RID<class_RID>`\ ) |
  50. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | |void| | :ref:`compute_list_bind_uniform_set<class_RenderingDevice_method_compute_list_bind_uniform_set>`\ (\ compute_list\: :ref:`int<class_int>`, uniform_set\: :ref:`RID<class_RID>`, set_index\: :ref:`int<class_int>`\ ) |
  52. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | |void| | :ref:`compute_list_dispatch<class_RenderingDevice_method_compute_list_dispatch>`\ (\ compute_list\: :ref:`int<class_int>`, x_groups\: :ref:`int<class_int>`, y_groups\: :ref:`int<class_int>`, z_groups\: :ref:`int<class_int>`\ ) |
  54. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | |void| | :ref:`compute_list_dispatch_indirect<class_RenderingDevice_method_compute_list_dispatch_indirect>`\ (\ compute_list\: :ref:`int<class_int>`, buffer\: :ref:`RID<class_RID>`, offset\: :ref:`int<class_int>`\ ) |
  56. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | |void| | :ref:`compute_list_end<class_RenderingDevice_method_compute_list_end>`\ (\ ) |
  58. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | |void| | :ref:`compute_list_set_push_constant<class_RenderingDevice_method_compute_list_set_push_constant>`\ (\ compute_list\: :ref:`int<class_int>`, buffer\: :ref:`PackedByteArray<class_PackedByteArray>`, size_bytes\: :ref:`int<class_int>`\ ) |
  60. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`RID<class_RID>` | :ref:`compute_pipeline_create<class_RenderingDevice_method_compute_pipeline_create>`\ (\ shader\: :ref:`RID<class_RID>`, specialization_constants\: :ref:`Array<class_Array>`\[:ref:`RDPipelineSpecializationConstant<class_RDPipelineSpecializationConstant>`\] = []\ ) |
  62. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`bool<class_bool>` | :ref:`compute_pipeline_is_valid<class_RenderingDevice_method_compute_pipeline_is_valid>`\ (\ compute_pipeline\: :ref:`RID<class_RID>`\ ) |
  64. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_device<class_RenderingDevice_method_create_local_device>`\ (\ ) |
  66. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | |void| | :ref:`draw_command_begin_label<class_RenderingDevice_method_draw_command_begin_label>`\ (\ name\: :ref:`String<class_String>`, color\: :ref:`Color<class_Color>`\ ) |
  68. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | |void| | :ref:`draw_command_end_label<class_RenderingDevice_method_draw_command_end_label>`\ (\ ) |
  70. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | |void| | :ref:`draw_command_insert_label<class_RenderingDevice_method_draw_command_insert_label>`\ (\ name\: :ref:`String<class_String>`, color\: :ref:`Color<class_Color>`\ ) |
  72. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`int<class_int>` | :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`\ (\ framebuffer\: :ref:`RID<class_RID>`, draw_flags\: |bitfield|\[:ref:`DrawFlags<enum_RenderingDevice_DrawFlags>`\] = 0, clear_color_values\: :ref:`PackedColorArray<class_PackedColorArray>` = PackedColorArray(), clear_depth_value\: :ref:`float<class_float>` = 1.0, clear_stencil_value\: :ref:`int<class_int>` = 0, region\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), breadcrumb\: :ref:`int<class_int>` = 0\ ) |
  74. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`int<class_int>` | :ref:`draw_list_begin_for_screen<class_RenderingDevice_method_draw_list_begin_for_screen>`\ (\ screen\: :ref:`int<class_int>` = 0, clear_color\: :ref:`Color<class_Color>` = Color(0, 0, 0, 1)\ ) |
  76. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`draw_list_begin_split<class_RenderingDevice_method_draw_list_begin_split>`\ (\ framebuffer\: :ref:`RID<class_RID>`, splits\: :ref:`int<class_int>`, initial_color_action\: :ref:`InitialAction<enum_RenderingDevice_InitialAction>`, final_color_action\: :ref:`FinalAction<enum_RenderingDevice_FinalAction>`, initial_depth_action\: :ref:`InitialAction<enum_RenderingDevice_InitialAction>`, final_depth_action\: :ref:`FinalAction<enum_RenderingDevice_FinalAction>`, clear_color_values\: :ref:`PackedColorArray<class_PackedColorArray>` = PackedColorArray(), clear_depth\: :ref:`float<class_float>` = 1.0, clear_stencil\: :ref:`int<class_int>` = 0, region\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), storage_textures\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] = []\ ) |
  78. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | |void| | :ref:`draw_list_bind_index_array<class_RenderingDevice_method_draw_list_bind_index_array>`\ (\ draw_list\: :ref:`int<class_int>`, index_array\: :ref:`RID<class_RID>`\ ) |
  80. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | |void| | :ref:`draw_list_bind_render_pipeline<class_RenderingDevice_method_draw_list_bind_render_pipeline>`\ (\ draw_list\: :ref:`int<class_int>`, render_pipeline\: :ref:`RID<class_RID>`\ ) |
  82. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | |void| | :ref:`draw_list_bind_uniform_set<class_RenderingDevice_method_draw_list_bind_uniform_set>`\ (\ draw_list\: :ref:`int<class_int>`, uniform_set\: :ref:`RID<class_RID>`, set_index\: :ref:`int<class_int>`\ ) |
  84. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | |void| | :ref:`draw_list_bind_vertex_array<class_RenderingDevice_method_draw_list_bind_vertex_array>`\ (\ draw_list\: :ref:`int<class_int>`, vertex_array\: :ref:`RID<class_RID>`\ ) |
  86. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | |void| | :ref:`draw_list_disable_scissor<class_RenderingDevice_method_draw_list_disable_scissor>`\ (\ draw_list\: :ref:`int<class_int>`\ ) |
  88. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | |void| | :ref:`draw_list_draw<class_RenderingDevice_method_draw_list_draw>`\ (\ draw_list\: :ref:`int<class_int>`, use_indices\: :ref:`bool<class_bool>`, instances\: :ref:`int<class_int>`, procedural_vertex_count\: :ref:`int<class_int>` = 0\ ) |
  90. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | |void| | :ref:`draw_list_draw_indirect<class_RenderingDevice_method_draw_list_draw_indirect>`\ (\ draw_list\: :ref:`int<class_int>`, use_indices\: :ref:`bool<class_bool>`, buffer\: :ref:`RID<class_RID>`, offset\: :ref:`int<class_int>` = 0, draw_count\: :ref:`int<class_int>` = 1, stride\: :ref:`int<class_int>` = 0\ ) |
  92. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | |void| | :ref:`draw_list_enable_scissor<class_RenderingDevice_method_draw_list_enable_scissor>`\ (\ draw_list\: :ref:`int<class_int>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0)\ ) |
  94. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | |void| | :ref:`draw_list_end<class_RenderingDevice_method_draw_list_end>`\ (\ ) |
  96. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | |void| | :ref:`draw_list_set_blend_constants<class_RenderingDevice_method_draw_list_set_blend_constants>`\ (\ draw_list\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) |
  98. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | |void| | :ref:`draw_list_set_push_constant<class_RenderingDevice_method_draw_list_set_push_constant>`\ (\ draw_list\: :ref:`int<class_int>`, buffer\: :ref:`PackedByteArray<class_PackedByteArray>`, size_bytes\: :ref:`int<class_int>`\ ) |
  100. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`int<class_int>` | :ref:`draw_list_switch_to_next_pass<class_RenderingDevice_method_draw_list_switch_to_next_pass>`\ (\ ) |
  102. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`draw_list_switch_to_next_pass_split<class_RenderingDevice_method_draw_list_switch_to_next_pass_split>`\ (\ splits\: :ref:`int<class_int>`\ ) |
  104. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`RID<class_RID>` | :ref:`framebuffer_create<class_RenderingDevice_method_framebuffer_create>`\ (\ textures\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], validate_with_format\: :ref:`int<class_int>` = -1, view_count\: :ref:`int<class_int>` = 1\ ) |
  106. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`RID<class_RID>` | :ref:`framebuffer_create_empty<class_RenderingDevice_method_framebuffer_create_empty>`\ (\ size\: :ref:`Vector2i<class_Vector2i>`, samples\: :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` = 0, validate_with_format\: :ref:`int<class_int>` = -1\ ) |
  108. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`RID<class_RID>` | :ref:`framebuffer_create_multipass<class_RenderingDevice_method_framebuffer_create_multipass>`\ (\ textures\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], passes\: :ref:`Array<class_Array>`\[:ref:`RDFramebufferPass<class_RDFramebufferPass>`\], validate_with_format\: :ref:`int<class_int>` = -1, view_count\: :ref:`int<class_int>` = 1\ ) |
  110. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`int<class_int>` | :ref:`framebuffer_format_create<class_RenderingDevice_method_framebuffer_format_create>`\ (\ attachments\: :ref:`Array<class_Array>`\[:ref:`RDAttachmentFormat<class_RDAttachmentFormat>`\], view_count\: :ref:`int<class_int>` = 1\ ) |
  112. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`int<class_int>` | :ref:`framebuffer_format_create_empty<class_RenderingDevice_method_framebuffer_format_create_empty>`\ (\ samples\: :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` = 0\ ) |
  114. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`int<class_int>` | :ref:`framebuffer_format_create_multipass<class_RenderingDevice_method_framebuffer_format_create_multipass>`\ (\ attachments\: :ref:`Array<class_Array>`\[:ref:`RDAttachmentFormat<class_RDAttachmentFormat>`\], passes\: :ref:`Array<class_Array>`\[:ref:`RDFramebufferPass<class_RDFramebufferPass>`\], view_count\: :ref:`int<class_int>` = 1\ ) |
  116. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` | :ref:`framebuffer_format_get_texture_samples<class_RenderingDevice_method_framebuffer_format_get_texture_samples>`\ (\ format\: :ref:`int<class_int>`, render_pass\: :ref:`int<class_int>` = 0\ ) |
  118. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`int<class_int>` | :ref:`framebuffer_get_format<class_RenderingDevice_method_framebuffer_get_format>`\ (\ framebuffer\: :ref:`RID<class_RID>`\ ) |
  120. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`bool<class_bool>` | :ref:`framebuffer_is_valid<class_RenderingDevice_method_framebuffer_is_valid>`\ (\ framebuffer\: :ref:`RID<class_RID>`\ ) |const| |
  122. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | |void| | :ref:`free_rid<class_RenderingDevice_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  124. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | |void| | :ref:`full_barrier<class_RenderingDevice_method_full_barrier>`\ (\ ) |
  126. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`int<class_int>` | :ref:`get_captured_timestamp_cpu_time<class_RenderingDevice_method_get_captured_timestamp_cpu_time>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  128. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`int<class_int>` | :ref:`get_captured_timestamp_gpu_time<class_RenderingDevice_method_get_captured_timestamp_gpu_time>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  130. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`String<class_String>` | :ref:`get_captured_timestamp_name<class_RenderingDevice_method_get_captured_timestamp_name>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  132. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`int<class_int>` | :ref:`get_captured_timestamps_count<class_RenderingDevice_method_get_captured_timestamps_count>`\ (\ ) |const| |
  134. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`int<class_int>` | :ref:`get_captured_timestamps_frame<class_RenderingDevice_method_get_captured_timestamps_frame>`\ (\ ) |const| |
  136. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`int<class_int>` | :ref:`get_device_allocation_count<class_RenderingDevice_method_get_device_allocation_count>`\ (\ ) |const| |
  138. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`int<class_int>` | :ref:`get_device_allocs_by_object_type<class_RenderingDevice_method_get_device_allocs_by_object_type>`\ (\ type\: :ref:`int<class_int>`\ ) |const| |
  140. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | :ref:`int<class_int>` | :ref:`get_device_memory_by_object_type<class_RenderingDevice_method_get_device_memory_by_object_type>`\ (\ type\: :ref:`int<class_int>`\ ) |const| |
  142. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`String<class_String>` | :ref:`get_device_name<class_RenderingDevice_method_get_device_name>`\ (\ ) |const| |
  144. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | :ref:`String<class_String>` | :ref:`get_device_pipeline_cache_uuid<class_RenderingDevice_method_get_device_pipeline_cache_uuid>`\ (\ ) |const| |
  146. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | :ref:`int<class_int>` | :ref:`get_device_total_memory<class_RenderingDevice_method_get_device_total_memory>`\ (\ ) |const| |
  148. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | :ref:`String<class_String>` | :ref:`get_device_vendor_name<class_RenderingDevice_method_get_device_vendor_name>`\ (\ ) |const| |
  150. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | :ref:`int<class_int>` | :ref:`get_driver_allocation_count<class_RenderingDevice_method_get_driver_allocation_count>`\ (\ ) |const| |
  152. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | :ref:`int<class_int>` | :ref:`get_driver_allocs_by_object_type<class_RenderingDevice_method_get_driver_allocs_by_object_type>`\ (\ type\: :ref:`int<class_int>`\ ) |const| |
  154. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | :ref:`String<class_String>` | :ref:`get_driver_and_device_memory_report<class_RenderingDevice_method_get_driver_and_device_memory_report>`\ (\ ) |const| |
  156. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | :ref:`int<class_int>` | :ref:`get_driver_memory_by_object_type<class_RenderingDevice_method_get_driver_memory_by_object_type>`\ (\ type\: :ref:`int<class_int>`\ ) |const| |
  158. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | :ref:`int<class_int>` | :ref:`get_driver_resource<class_RenderingDevice_method_get_driver_resource>`\ (\ resource\: :ref:`DriverResource<enum_RenderingDevice_DriverResource>`, rid\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |
  160. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | :ref:`int<class_int>` | :ref:`get_driver_total_memory<class_RenderingDevice_method_get_driver_total_memory>`\ (\ ) |const| |
  162. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :ref:`int<class_int>` | :ref:`get_frame_delay<class_RenderingDevice_method_get_frame_delay>`\ (\ ) |const| |
  164. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :ref:`int<class_int>` | :ref:`get_memory_usage<class_RenderingDevice_method_get_memory_usage>`\ (\ type\: :ref:`MemoryType<enum_RenderingDevice_MemoryType>`\ ) |const| |
  166. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :ref:`String<class_String>` | :ref:`get_perf_report<class_RenderingDevice_method_get_perf_report>`\ (\ ) |const| |
  168. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | :ref:`String<class_String>` | :ref:`get_tracked_object_name<class_RenderingDevice_method_get_tracked_object_name>`\ (\ type_index\: :ref:`int<class_int>`\ ) |const| |
  170. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | :ref:`int<class_int>` | :ref:`get_tracked_object_type_count<class_RenderingDevice_method_get_tracked_object_type_count>`\ (\ ) |const| |
  172. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | :ref:`bool<class_bool>` | :ref:`has_feature<class_RenderingDevice_method_has_feature>`\ (\ feature\: :ref:`Features<enum_RenderingDevice_Features>`\ ) |const| |
  174. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | :ref:`RID<class_RID>` | :ref:`index_array_create<class_RenderingDevice_method_index_array_create>`\ (\ index_buffer\: :ref:`RID<class_RID>`, index_offset\: :ref:`int<class_int>`, index_count\: :ref:`int<class_int>`\ ) |
  176. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | :ref:`RID<class_RID>` | :ref:`index_buffer_create<class_RenderingDevice_method_index_buffer_create>`\ (\ size_indices\: :ref:`int<class_int>`, format\: :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray(), use_restart_indices\: :ref:`bool<class_bool>` = false, enable_device_address\: :ref:`bool<class_bool>` = false\ ) |
  178. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | :ref:`int<class_int>` | :ref:`limit_get<class_RenderingDevice_method_limit_get>`\ (\ limit\: :ref:`Limit<enum_RenderingDevice_Limit>`\ ) |const| |
  180. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | :ref:`RID<class_RID>` | :ref:`render_pipeline_create<class_RenderingDevice_method_render_pipeline_create>`\ (\ shader\: :ref:`RID<class_RID>`, framebuffer_format\: :ref:`int<class_int>`, vertex_format\: :ref:`int<class_int>`, primitive\: :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>`, rasterization_state\: :ref:`RDPipelineRasterizationState<class_RDPipelineRasterizationState>`, multisample_state\: :ref:`RDPipelineMultisampleState<class_RDPipelineMultisampleState>`, stencil_state\: :ref:`RDPipelineDepthStencilState<class_RDPipelineDepthStencilState>`, color_blend_state\: :ref:`RDPipelineColorBlendState<class_RDPipelineColorBlendState>`, dynamic_state_flags\: |bitfield|\[:ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>`\] = 0, for_render_pass\: :ref:`int<class_int>` = 0, specialization_constants\: :ref:`Array<class_Array>`\[:ref:`RDPipelineSpecializationConstant<class_RDPipelineSpecializationConstant>`\] = []\ ) |
  182. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | :ref:`bool<class_bool>` | :ref:`render_pipeline_is_valid<class_RenderingDevice_method_render_pipeline_is_valid>`\ (\ render_pipeline\: :ref:`RID<class_RID>`\ ) |
  184. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | :ref:`RID<class_RID>` | :ref:`sampler_create<class_RenderingDevice_method_sampler_create>`\ (\ state\: :ref:`RDSamplerState<class_RDSamplerState>`\ ) |
  186. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :ref:`bool<class_bool>` | :ref:`sampler_is_format_supported_for_filter<class_RenderingDevice_method_sampler_is_format_supported_for_filter>`\ (\ format\: :ref:`DataFormat<enum_RenderingDevice_DataFormat>`, sampler_filter\: :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>`\ ) |const| |
  188. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | :ref:`int<class_int>` | :ref:`screen_get_framebuffer_format<class_RenderingDevice_method_screen_get_framebuffer_format>`\ (\ screen\: :ref:`int<class_int>` = 0\ ) |const| |
  190. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`int<class_int>` | :ref:`screen_get_height<class_RenderingDevice_method_screen_get_height>`\ (\ screen\: :ref:`int<class_int>` = 0\ ) |const| |
  192. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | :ref:`int<class_int>` | :ref:`screen_get_width<class_RenderingDevice_method_screen_get_width>`\ (\ screen\: :ref:`int<class_int>` = 0\ ) |const| |
  194. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | |void| | :ref:`set_resource_name<class_RenderingDevice_method_set_resource_name>`\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  196. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`shader_compile_binary_from_spirv<class_RenderingDevice_method_shader_compile_binary_from_spirv>`\ (\ spirv_data\: :ref:`RDShaderSPIRV<class_RDShaderSPIRV>`, name\: :ref:`String<class_String>` = ""\ ) |
  198. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` | :ref:`shader_compile_spirv_from_source<class_RenderingDevice_method_shader_compile_spirv_from_source>`\ (\ shader_source\: :ref:`RDShaderSource<class_RDShaderSource>`, allow_cache\: :ref:`bool<class_bool>` = true\ ) |
  200. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | :ref:`RID<class_RID>` | :ref:`shader_create_from_bytecode<class_RenderingDevice_method_shader_create_from_bytecode>`\ (\ binary_data\: :ref:`PackedByteArray<class_PackedByteArray>`, placeholder_rid\: :ref:`RID<class_RID>` = RID()\ ) |
  202. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :ref:`RID<class_RID>` | :ref:`shader_create_from_spirv<class_RenderingDevice_method_shader_create_from_spirv>`\ (\ spirv_data\: :ref:`RDShaderSPIRV<class_RDShaderSPIRV>`, name\: :ref:`String<class_String>` = ""\ ) |
  204. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | :ref:`RID<class_RID>` | :ref:`shader_create_placeholder<class_RenderingDevice_method_shader_create_placeholder>`\ (\ ) |
  206. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | :ref:`int<class_int>` | :ref:`shader_get_vertex_input_attribute_mask<class_RenderingDevice_method_shader_get_vertex_input_attribute_mask>`\ (\ shader\: :ref:`RID<class_RID>`\ ) |
  208. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | :ref:`RID<class_RID>` | :ref:`storage_buffer_create<class_RenderingDevice_method_storage_buffer_create>`\ (\ size_bytes\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray(), usage\: |bitfield|\[:ref:`StorageBufferUsage<enum_RenderingDevice_StorageBufferUsage>`\] = 0\ ) |
  210. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | |void| | :ref:`submit<class_RenderingDevice_method_submit>`\ (\ ) |
  212. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | |void| | :ref:`sync<class_RenderingDevice_method_sync>`\ (\ ) |
  214. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | :ref:`RID<class_RID>` | :ref:`texture_buffer_create<class_RenderingDevice_method_texture_buffer_create>`\ (\ size_bytes\: :ref:`int<class_int>`, format\: :ref:`DataFormat<enum_RenderingDevice_DataFormat>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray()\ ) |
  216. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_clear<class_RenderingDevice_method_texture_clear>`\ (\ texture\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`, base_mipmap\: :ref:`int<class_int>`, mipmap_count\: :ref:`int<class_int>`, base_layer\: :ref:`int<class_int>`, layer_count\: :ref:`int<class_int>`\ ) |
  218. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_copy<class_RenderingDevice_method_texture_copy>`\ (\ from_texture\: :ref:`RID<class_RID>`, to_texture\: :ref:`RID<class_RID>`, from_pos\: :ref:`Vector3<class_Vector3>`, to_pos\: :ref:`Vector3<class_Vector3>`, size\: :ref:`Vector3<class_Vector3>`, src_mipmap\: :ref:`int<class_int>`, dst_mipmap\: :ref:`int<class_int>`, src_layer\: :ref:`int<class_int>`, dst_layer\: :ref:`int<class_int>`\ ) |
  220. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | :ref:`RID<class_RID>` | :ref:`texture_create<class_RenderingDevice_method_texture_create>`\ (\ format\: :ref:`RDTextureFormat<class_RDTextureFormat>`, view\: :ref:`RDTextureView<class_RDTextureView>`, data\: :ref:`Array<class_Array>`\[:ref:`PackedByteArray<class_PackedByteArray>`\] = []\ ) |
  222. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | :ref:`RID<class_RID>` | :ref:`texture_create_from_extension<class_RenderingDevice_method_texture_create_from_extension>`\ (\ type\: :ref:`TextureType<enum_RenderingDevice_TextureType>`, format\: :ref:`DataFormat<enum_RenderingDevice_DataFormat>`, samples\: :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>`\], image\: :ref:`int<class_int>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, layers\: :ref:`int<class_int>`\ ) |
  224. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | :ref:`RID<class_RID>` | :ref:`texture_create_shared<class_RenderingDevice_method_texture_create_shared>`\ (\ view\: :ref:`RDTextureView<class_RDTextureView>`, with_texture\: :ref:`RID<class_RID>`\ ) |
  226. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | :ref:`RID<class_RID>` | :ref:`texture_create_shared_from_slice<class_RenderingDevice_method_texture_create_shared_from_slice>`\ (\ view\: :ref:`RDTextureView<class_RDTextureView>`, with_texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, mipmap\: :ref:`int<class_int>`, mipmaps\: :ref:`int<class_int>` = 1, slice_type\: :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` = 0\ ) |
  228. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`texture_get_data<class_RenderingDevice_method_texture_get_data>`\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) |
  230. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_get_data_async<class_RenderingDevice_method_texture_get_data_async>`\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) |
  232. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | :ref:`RDTextureFormat<class_RDTextureFormat>` | :ref:`texture_get_format<class_RenderingDevice_method_texture_get_format>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |
  234. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | :ref:`int<class_int>` | :ref:`texture_get_native_handle<class_RenderingDevice_method_texture_get_native_handle>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |
  236. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | :ref:`bool<class_bool>` | :ref:`texture_is_discardable<class_RenderingDevice_method_texture_is_discardable>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |
  238. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | :ref:`bool<class_bool>` | :ref:`texture_is_format_supported_for_usage<class_RenderingDevice_method_texture_is_format_supported_for_usage>`\ (\ format\: :ref:`DataFormat<enum_RenderingDevice_DataFormat>`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>`\]\ ) |const| |
  240. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | :ref:`bool<class_bool>` | :ref:`texture_is_shared<class_RenderingDevice_method_texture_is_shared>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |
  242. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | :ref:`bool<class_bool>` | :ref:`texture_is_valid<class_RenderingDevice_method_texture_is_valid>`\ (\ texture\: :ref:`RID<class_RID>`\ ) |
  244. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_resolve_multisample<class_RenderingDevice_method_texture_resolve_multisample>`\ (\ from_texture\: :ref:`RID<class_RID>`, to_texture\: :ref:`RID<class_RID>`\ ) |
  246. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | |void| | :ref:`texture_set_discardable<class_RenderingDevice_method_texture_set_discardable>`\ (\ texture\: :ref:`RID<class_RID>`, discardable\: :ref:`bool<class_bool>`\ ) |
  248. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_update<class_RenderingDevice_method_texture_update>`\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  250. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | :ref:`RID<class_RID>` | :ref:`uniform_buffer_create<class_RenderingDevice_method_uniform_buffer_create>`\ (\ size_bytes\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray(), enable_device_address\: :ref:`bool<class_bool>` = false\ ) |
  252. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | :ref:`RID<class_RID>` | :ref:`uniform_set_create<class_RenderingDevice_method_uniform_set_create>`\ (\ uniforms\: :ref:`Array<class_Array>`\[:ref:`RDUniform<class_RDUniform>`\], shader\: :ref:`RID<class_RID>`, shader_set\: :ref:`int<class_int>`\ ) |
  254. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | :ref:`bool<class_bool>` | :ref:`uniform_set_is_valid<class_RenderingDevice_method_uniform_set_is_valid>`\ (\ uniform_set\: :ref:`RID<class_RID>`\ ) |
  256. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | :ref:`RID<class_RID>` | :ref:`vertex_array_create<class_RenderingDevice_method_vertex_array_create>`\ (\ vertex_count\: :ref:`int<class_int>`, vertex_format\: :ref:`int<class_int>`, src_buffers\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], offsets\: :ref:`PackedInt64Array<class_PackedInt64Array>` = PackedInt64Array()\ ) |
  258. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | :ref:`RID<class_RID>` | :ref:`vertex_buffer_create<class_RenderingDevice_method_vertex_buffer_create>`\ (\ size_bytes\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray(), use_as_storage\: :ref:`bool<class_bool>` = false, enable_device_address\: :ref:`bool<class_bool>` = false\ ) |
  260. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | :ref:`int<class_int>` | :ref:`vertex_format_create<class_RenderingDevice_method_vertex_format_create>`\ (\ vertex_descriptions\: :ref:`Array<class_Array>`\[:ref:`RDVertexAttribute<class_RDVertexAttribute>`\]\ ) |
  262. +------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. .. rst-class:: classref-section-separator
  264. ----
  265. .. rst-class:: classref-descriptions-group
  266. Enumerations
  267. ------------
  268. .. _enum_RenderingDevice_DeviceType:
  269. .. rst-class:: classref-enumeration
  270. enum **DeviceType**: :ref:`๐Ÿ”—<enum_RenderingDevice_DeviceType>`
  271. .. _class_RenderingDevice_constant_DEVICE_TYPE_OTHER:
  272. .. rst-class:: classref-enumeration-constant
  273. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_OTHER** = ``0``
  274. Rendering device type does not match any of the other enum values or is unknown.
  275. .. _class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU:
  276. .. rst-class:: classref-enumeration-constant
  277. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_INTEGRATED_GPU** = ``1``
  278. Rendering device is an integrated GPU, which is typically *(but not always)* slower than dedicated GPUs (:ref:`DEVICE_TYPE_DISCRETE_GPU<class_RenderingDevice_constant_DEVICE_TYPE_DISCRETE_GPU>`). On Android and iOS, the rendering device type is always considered to be :ref:`DEVICE_TYPE_INTEGRATED_GPU<class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU>`.
  279. .. _class_RenderingDevice_constant_DEVICE_TYPE_DISCRETE_GPU:
  280. .. rst-class:: classref-enumeration-constant
  281. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_DISCRETE_GPU** = ``2``
  282. Rendering device is a dedicated GPU, which is typically *(but not always)* faster than integrated GPUs (:ref:`DEVICE_TYPE_INTEGRATED_GPU<class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU>`).
  283. .. _class_RenderingDevice_constant_DEVICE_TYPE_VIRTUAL_GPU:
  284. .. rst-class:: classref-enumeration-constant
  285. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_VIRTUAL_GPU** = ``3``
  286. Rendering device is an emulated GPU in a virtual environment. This is typically much slower than the host GPU, which means the expected performance level on a dedicated GPU will be roughly equivalent to :ref:`DEVICE_TYPE_INTEGRATED_GPU<class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU>`. Virtual machine GPU passthrough (such as VFIO) will not report the device type as :ref:`DEVICE_TYPE_VIRTUAL_GPU<class_RenderingDevice_constant_DEVICE_TYPE_VIRTUAL_GPU>`. Instead, the host GPU's device type will be reported as if the GPU was not emulated.
  287. .. _class_RenderingDevice_constant_DEVICE_TYPE_CPU:
  288. .. rst-class:: classref-enumeration-constant
  289. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_CPU** = ``4``
  290. Rendering device is provided by software emulation (such as Lavapipe or `SwiftShader <https://github.com/google/swiftshader>`__). This is the slowest kind of rendering device available; it's typically much slower than :ref:`DEVICE_TYPE_INTEGRATED_GPU<class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU>`.
  291. .. _class_RenderingDevice_constant_DEVICE_TYPE_MAX:
  292. .. rst-class:: classref-enumeration-constant
  293. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_MAX** = ``5``
  294. Represents the size of the :ref:`DeviceType<enum_RenderingDevice_DeviceType>` enum.
  295. .. rst-class:: classref-item-separator
  296. ----
  297. .. _enum_RenderingDevice_DriverResource:
  298. .. rst-class:: classref-enumeration
  299. enum **DriverResource**: :ref:`๐Ÿ”—<enum_RenderingDevice_DriverResource>`
  300. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_LOGICAL_DEVICE:
  301. .. rst-class:: classref-enumeration-constant
  302. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_LOGICAL_DEVICE** = ``0``
  303. Specific device object based on a physical device.
  304. - Vulkan: Vulkan device driver resource (``VkDevice``). (``rid`` argument doesn't apply.)
  305. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_PHYSICAL_DEVICE:
  306. .. rst-class:: classref-enumeration-constant
  307. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_PHYSICAL_DEVICE** = ``1``
  308. Physical device the specific logical device is based on.
  309. - Vulkan: ``VkDevice``. (``rid`` argument doesn't apply.)
  310. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_TOPMOST_OBJECT:
  311. .. rst-class:: classref-enumeration-constant
  312. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_TOPMOST_OBJECT** = ``2``
  313. Top-most graphics API entry object.
  314. - Vulkan: ``VkInstance``. (``rid`` argument doesn't apply.)
  315. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_COMMAND_QUEUE:
  316. .. rst-class:: classref-enumeration-constant
  317. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_COMMAND_QUEUE** = ``3``
  318. The main graphics-compute command queue.
  319. - Vulkan: ``VkQueue``. (``rid`` argument doesn't apply.)
  320. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_QUEUE_FAMILY:
  321. .. rst-class:: classref-enumeration-constant
  322. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_QUEUE_FAMILY** = ``4``
  323. The specific family the main queue belongs to.
  324. - Vulkan: the queue family index, an ``uint32_t``. (``rid`` argument doesn't apply.)
  325. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_TEXTURE:
  326. .. rst-class:: classref-enumeration-constant
  327. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_TEXTURE** = ``5``
  328. - Vulkan: ``VkImage``.
  329. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_TEXTURE_VIEW:
  330. .. rst-class:: classref-enumeration-constant
  331. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_TEXTURE_VIEW** = ``6``
  332. The view of an owned or shared texture.
  333. - Vulkan: ``VkImageView``.
  334. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_TEXTURE_DATA_FORMAT:
  335. .. rst-class:: classref-enumeration-constant
  336. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_TEXTURE_DATA_FORMAT** = ``7``
  337. The native id of the data format of the texture.
  338. - Vulkan: ``VkFormat``.
  339. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_SAMPLER:
  340. .. rst-class:: classref-enumeration-constant
  341. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_SAMPLER** = ``8``
  342. - Vulkan: ``VkSampler``.
  343. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_UNIFORM_SET:
  344. .. rst-class:: classref-enumeration-constant
  345. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_UNIFORM_SET** = ``9``
  346. - Vulkan: ``VkDescriptorSet``.
  347. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_BUFFER:
  348. .. rst-class:: classref-enumeration-constant
  349. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_BUFFER** = ``10``
  350. Buffer of any kind of (storage, vertex, etc.).
  351. - Vulkan: ``VkBuffer``.
  352. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_COMPUTE_PIPELINE:
  353. .. rst-class:: classref-enumeration-constant
  354. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_COMPUTE_PIPELINE** = ``11``
  355. - Vulkan: ``VkPipeline``.
  356. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_RENDER_PIPELINE:
  357. .. rst-class:: classref-enumeration-constant
  358. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_RENDER_PIPELINE** = ``12``
  359. - Vulkan: ``VkPipeline``.
  360. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DEVICE:
  361. .. rst-class:: classref-enumeration-constant
  362. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_DEVICE** = ``0``
  363. **Deprecated:** Use :ref:`DRIVER_RESOURCE_LOGICAL_DEVICE<class_RenderingDevice_constant_DRIVER_RESOURCE_LOGICAL_DEVICE>` instead.
  364. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE:
  365. .. rst-class:: classref-enumeration-constant
  366. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE** = ``1``
  367. **Deprecated:** Use :ref:`DRIVER_RESOURCE_PHYSICAL_DEVICE<class_RenderingDevice_constant_DRIVER_RESOURCE_PHYSICAL_DEVICE>` instead.
  368. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_INSTANCE:
  369. .. rst-class:: classref-enumeration-constant
  370. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_INSTANCE** = ``2``
  371. **Deprecated:** Use :ref:`DRIVER_RESOURCE_TOPMOST_OBJECT<class_RenderingDevice_constant_DRIVER_RESOURCE_TOPMOST_OBJECT>` instead.
  372. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE:
  373. .. rst-class:: classref-enumeration-constant
  374. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_QUEUE** = ``3``
  375. **Deprecated:** Use :ref:`DRIVER_RESOURCE_COMMAND_QUEUE<class_RenderingDevice_constant_DRIVER_RESOURCE_COMMAND_QUEUE>` instead.
  376. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX:
  377. .. rst-class:: classref-enumeration-constant
  378. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX** = ``4``
  379. **Deprecated:** Use :ref:`DRIVER_RESOURCE_QUEUE_FAMILY<class_RenderingDevice_constant_DRIVER_RESOURCE_QUEUE_FAMILY>` instead.
  380. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE:
  381. .. rst-class:: classref-enumeration-constant
  382. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_IMAGE** = ``5``
  383. **Deprecated:** Use :ref:`DRIVER_RESOURCE_TEXTURE<class_RenderingDevice_constant_DRIVER_RESOURCE_TEXTURE>` instead.
  384. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_VIEW:
  385. .. rst-class:: classref-enumeration-constant
  386. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_IMAGE_VIEW** = ``6``
  387. **Deprecated:** Use :ref:`DRIVER_RESOURCE_TEXTURE_VIEW<class_RenderingDevice_constant_DRIVER_RESOURCE_TEXTURE_VIEW>` instead.
  388. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT:
  389. .. rst-class:: classref-enumeration-constant
  390. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT** = ``7``
  391. **Deprecated:** Use :ref:`DRIVER_RESOURCE_TEXTURE_DATA_FORMAT<class_RenderingDevice_constant_DRIVER_RESOURCE_TEXTURE_DATA_FORMAT>` instead.
  392. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_SAMPLER:
  393. .. rst-class:: classref-enumeration-constant
  394. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_SAMPLER** = ``8``
  395. **Deprecated:** Use :ref:`DRIVER_RESOURCE_SAMPLER<class_RenderingDevice_constant_DRIVER_RESOURCE_SAMPLER>` instead.
  396. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET:
  397. .. rst-class:: classref-enumeration-constant
  398. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET** = ``9``
  399. **Deprecated:** Use :ref:`DRIVER_RESOURCE_UNIFORM_SET<class_RenderingDevice_constant_DRIVER_RESOURCE_UNIFORM_SET>` instead.
  400. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_BUFFER:
  401. .. rst-class:: classref-enumeration-constant
  402. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_BUFFER** = ``10``
  403. **Deprecated:** Use :ref:`DRIVER_RESOURCE_BUFFER<class_RenderingDevice_constant_DRIVER_RESOURCE_BUFFER>` instead.
  404. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE:
  405. .. rst-class:: classref-enumeration-constant
  406. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE** = ``11``
  407. **Deprecated:** Use :ref:`DRIVER_RESOURCE_COMPUTE_PIPELINE<class_RenderingDevice_constant_DRIVER_RESOURCE_COMPUTE_PIPELINE>` instead.
  408. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE:
  409. .. rst-class:: classref-enumeration-constant
  410. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE** = ``12``
  411. **Deprecated:** Use :ref:`DRIVER_RESOURCE_RENDER_PIPELINE<class_RenderingDevice_constant_DRIVER_RESOURCE_RENDER_PIPELINE>` instead.
  412. .. rst-class:: classref-item-separator
  413. ----
  414. .. _enum_RenderingDevice_DataFormat:
  415. .. rst-class:: classref-enumeration
  416. enum **DataFormat**: :ref:`๐Ÿ”—<enum_RenderingDevice_DataFormat>`
  417. .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4_UNORM_PACK8:
  418. .. rst-class:: classref-enumeration-constant
  419. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R4G4_UNORM_PACK8** = ``0``
  420. 4-bit-per-channel red/green channel data format, packed into 8 bits. Values are in the ``[0.0, 1.0]`` range.
  421. \ **Note:** More information on all data formats can be found on the `Identification of formats <https://registry.khronos.org/vulkan/specs/1.1/html/vkspec.html#_identification_of_formats>`__ section of the Vulkan specification, as well as the `VkFormat <https://registry.khronos.org/vulkan/specs/1.3-extensions/man/html/VkFormat.html>`__ enum.
  422. .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4B4A4_UNORM_PACK16:
  423. .. rst-class:: classref-enumeration-constant
  424. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R4G4B4A4_UNORM_PACK16** = ``1``
  425. 4-bit-per-channel red/green/blue/alpha channel data format, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  426. .. _class_RenderingDevice_constant_DATA_FORMAT_B4G4R4A4_UNORM_PACK16:
  427. .. rst-class:: classref-enumeration-constant
  428. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B4G4R4A4_UNORM_PACK16** = ``2``
  429. 4-bit-per-channel blue/green/red/alpha channel data format, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  430. .. _class_RenderingDevice_constant_DATA_FORMAT_R5G6B5_UNORM_PACK16:
  431. .. rst-class:: classref-enumeration-constant
  432. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R5G6B5_UNORM_PACK16** = ``3``
  433. Red/green/blue channel data format with 5 bits of red, 6 bits of green and 5 bits of blue, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  434. .. _class_RenderingDevice_constant_DATA_FORMAT_B5G6R5_UNORM_PACK16:
  435. .. rst-class:: classref-enumeration-constant
  436. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B5G6R5_UNORM_PACK16** = ``4``
  437. Blue/green/red channel data format with 5 bits of blue, 6 bits of green and 5 bits of red, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  438. .. _class_RenderingDevice_constant_DATA_FORMAT_R5G5B5A1_UNORM_PACK16:
  439. .. rst-class:: classref-enumeration-constant
  440. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R5G5B5A1_UNORM_PACK16** = ``5``
  441. Red/green/blue/alpha channel data format with 5 bits of red, 6 bits of green, 5 bits of blue and 1 bit of alpha, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  442. .. _class_RenderingDevice_constant_DATA_FORMAT_B5G5R5A1_UNORM_PACK16:
  443. .. rst-class:: classref-enumeration-constant
  444. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B5G5R5A1_UNORM_PACK16** = ``6``
  445. Blue/green/red/alpha channel data format with 5 bits of blue, 6 bits of green, 5 bits of red and 1 bit of alpha, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  446. .. _class_RenderingDevice_constant_DATA_FORMAT_A1R5G5B5_UNORM_PACK16:
  447. .. rst-class:: classref-enumeration-constant
  448. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A1R5G5B5_UNORM_PACK16** = ``7``
  449. Alpha/red/green/blue channel data format with 1 bit of alpha, 5 bits of red, 6 bits of green and 5 bits of blue, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  450. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UNORM:
  451. .. rst-class:: classref-enumeration-constant
  452. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_UNORM** = ``8``
  453. 8-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  454. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SNORM:
  455. .. rst-class:: classref-enumeration-constant
  456. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SNORM** = ``9``
  457. 8-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  458. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_USCALED:
  459. .. rst-class:: classref-enumeration-constant
  460. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_USCALED** = ``10``
  461. 8-bit-per-channel unsigned floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 255.0]`` range.
  462. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SSCALED:
  463. .. rst-class:: classref-enumeration-constant
  464. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SSCALED** = ``11``
  465. 8-bit-per-channel signed floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the ``[-127.0, 127.0]`` range.
  466. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UINT:
  467. .. rst-class:: classref-enumeration-constant
  468. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_UINT** = ``12``
  469. 8-bit-per-channel unsigned integer red channel data format. Values are in the ``[0, 255]`` range.
  470. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SINT:
  471. .. rst-class:: classref-enumeration-constant
  472. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SINT** = ``13``
  473. 8-bit-per-channel signed integer red channel data format. Values are in the ``[-127, 127]`` range.
  474. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SRGB:
  475. .. rst-class:: classref-enumeration-constant
  476. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SRGB** = ``14``
  477. 8-bit-per-channel unsigned floating-point red channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range.
  478. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UNORM:
  479. .. rst-class:: classref-enumeration-constant
  480. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_UNORM** = ``15``
  481. 8-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  482. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SNORM:
  483. .. rst-class:: classref-enumeration-constant
  484. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SNORM** = ``16``
  485. 8-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  486. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_USCALED:
  487. .. rst-class:: classref-enumeration-constant
  488. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_USCALED** = ``17``
  489. 8-bit-per-channel unsigned floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 255.0]`` range.
  490. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SSCALED:
  491. .. rst-class:: classref-enumeration-constant
  492. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SSCALED** = ``18``
  493. 8-bit-per-channel signed floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the ``[-127.0, 127.0]`` range.
  494. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UINT:
  495. .. rst-class:: classref-enumeration-constant
  496. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_UINT** = ``19``
  497. 8-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0, 255]`` range.
  498. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SINT:
  499. .. rst-class:: classref-enumeration-constant
  500. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SINT** = ``20``
  501. 8-bit-per-channel signed integer red/green channel data format. Values are in the ``[-127, 127]`` range.
  502. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SRGB:
  503. .. rst-class:: classref-enumeration-constant
  504. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SRGB** = ``21``
  505. 8-bit-per-channel unsigned floating-point red/green channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range.
  506. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UNORM:
  507. .. rst-class:: classref-enumeration-constant
  508. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_UNORM** = ``22``
  509. 8-bit-per-channel unsigned floating-point red/green/blue channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  510. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SNORM:
  511. .. rst-class:: classref-enumeration-constant
  512. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SNORM** = ``23``
  513. 8-bit-per-channel signed floating-point red/green/blue channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  514. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_USCALED:
  515. .. rst-class:: classref-enumeration-constant
  516. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_USCALED** = ``24``
  517. 8-bit-per-channel unsigned floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 255.0]`` range.
  518. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SSCALED:
  519. .. rst-class:: classref-enumeration-constant
  520. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SSCALED** = ``25``
  521. 8-bit-per-channel signed floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the ``[-127.0, 127.0]`` range.
  522. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UINT:
  523. .. rst-class:: classref-enumeration-constant
  524. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_UINT** = ``26``
  525. 8-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0, 255]`` range.
  526. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SINT:
  527. .. rst-class:: classref-enumeration-constant
  528. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SINT** = ``27``
  529. 8-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[-127, 127]`` range.
  530. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SRGB:
  531. .. rst-class:: classref-enumeration-constant
  532. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SRGB** = ``28``
  533. 8-bit-per-channel unsigned floating-point red/green/blue/blue channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range.
  534. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UNORM:
  535. .. rst-class:: classref-enumeration-constant
  536. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_UNORM** = ``29``
  537. 8-bit-per-channel unsigned floating-point blue/green/red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  538. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SNORM:
  539. .. rst-class:: classref-enumeration-constant
  540. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SNORM** = ``30``
  541. 8-bit-per-channel signed floating-point blue/green/red channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  542. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_USCALED:
  543. .. rst-class:: classref-enumeration-constant
  544. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_USCALED** = ``31``
  545. 8-bit-per-channel unsigned floating-point blue/green/red channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 255.0]`` range.
  546. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SSCALED:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SSCALED** = ``32``
  549. 8-bit-per-channel signed floating-point blue/green/red channel data format with scaled value (value is converted from integer to float). Values are in the ``[-127.0, 127.0]`` range.
  550. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UINT:
  551. .. rst-class:: classref-enumeration-constant
  552. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_UINT** = ``33``
  553. 8-bit-per-channel unsigned integer blue/green/red channel data format. Values are in the ``[0, 255]`` range.
  554. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SINT:
  555. .. rst-class:: classref-enumeration-constant
  556. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SINT** = ``34``
  557. 8-bit-per-channel signed integer blue/green/red channel data format. Values are in the ``[-127, 127]`` range.
  558. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SRGB:
  559. .. rst-class:: classref-enumeration-constant
  560. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SRGB** = ``35``
  561. 8-bit-per-channel unsigned floating-point blue/green/red data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range.
  562. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UNORM:
  563. .. rst-class:: classref-enumeration-constant
  564. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_UNORM** = ``36``
  565. 8-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  566. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SNORM:
  567. .. rst-class:: classref-enumeration-constant
  568. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SNORM** = ``37``
  569. 8-bit-per-channel signed floating-point red/green/blue/alpha channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  570. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_USCALED:
  571. .. rst-class:: classref-enumeration-constant
  572. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_USCALED** = ``38``
  573. 8-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 255.0]`` range.
  574. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SSCALED:
  575. .. rst-class:: classref-enumeration-constant
  576. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SSCALED** = ``39``
  577. 8-bit-per-channel signed floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the ``[-127.0, 127.0]`` range.
  578. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UINT:
  579. .. rst-class:: classref-enumeration-constant
  580. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_UINT** = ``40``
  581. 8-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0, 255]`` range.
  582. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SINT:
  583. .. rst-class:: classref-enumeration-constant
  584. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SINT** = ``41``
  585. 8-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[-127, 127]`` range.
  586. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SRGB:
  587. .. rst-class:: classref-enumeration-constant
  588. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SRGB** = ``42``
  589. 8-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range.
  590. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UNORM:
  591. .. rst-class:: classref-enumeration-constant
  592. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_UNORM** = ``43``
  593. 8-bit-per-channel unsigned floating-point blue/green/red/alpha channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  594. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SNORM:
  595. .. rst-class:: classref-enumeration-constant
  596. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SNORM** = ``44``
  597. 8-bit-per-channel signed floating-point blue/green/red/alpha channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  598. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_USCALED:
  599. .. rst-class:: classref-enumeration-constant
  600. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_USCALED** = ``45``
  601. 8-bit-per-channel unsigned floating-point blue/green/red/alpha channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 255.0]`` range.
  602. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SSCALED:
  603. .. rst-class:: classref-enumeration-constant
  604. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SSCALED** = ``46``
  605. 8-bit-per-channel signed floating-point blue/green/red/alpha channel data format with scaled value (value is converted from integer to float). Values are in the ``[-127.0, 127.0]`` range.
  606. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UINT:
  607. .. rst-class:: classref-enumeration-constant
  608. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_UINT** = ``47``
  609. 8-bit-per-channel unsigned integer blue/green/red/alpha channel data format. Values are in the ``[0, 255]`` range.
  610. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SINT:
  611. .. rst-class:: classref-enumeration-constant
  612. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SINT** = ``48``
  613. 8-bit-per-channel signed integer blue/green/red/alpha channel data format. Values are in the ``[-127, 127]`` range.
  614. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SRGB:
  615. .. rst-class:: classref-enumeration-constant
  616. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SRGB** = ``49``
  617. 8-bit-per-channel unsigned floating-point blue/green/red/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range.
  618. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UNORM_PACK32:
  619. .. rst-class:: classref-enumeration-constant
  620. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_UNORM_PACK32** = ``50``
  621. 8-bit-per-channel unsigned floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Values are in the ``[0.0, 1.0]`` range.
  622. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SNORM_PACK32:
  623. .. rst-class:: classref-enumeration-constant
  624. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SNORM_PACK32** = ``51``
  625. 8-bit-per-channel signed floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Values are in the ``[-1.0, 1.0]`` range.
  626. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_USCALED_PACK32:
  627. .. rst-class:: classref-enumeration-constant
  628. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_USCALED_PACK32** = ``52``
  629. 8-bit-per-channel unsigned floating-point alpha/red/green/blue channel data format with scaled value (value is converted from integer to float), packed in 32 bits. Values are in the ``[0.0, 255.0]`` range.
  630. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SSCALED_PACK32:
  631. .. rst-class:: classref-enumeration-constant
  632. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SSCALED_PACK32** = ``53``
  633. 8-bit-per-channel signed floating-point alpha/red/green/blue channel data format with scaled value (value is converted from integer to float), packed in 32 bits. Values are in the ``[-127.0, 127.0]`` range.
  634. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UINT_PACK32:
  635. .. rst-class:: classref-enumeration-constant
  636. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_UINT_PACK32** = ``54``
  637. 8-bit-per-channel unsigned integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the ``[0, 255]`` range.
  638. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SINT_PACK32:
  639. .. rst-class:: classref-enumeration-constant
  640. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SINT_PACK32** = ``55``
  641. 8-bit-per-channel signed integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the ``[-127, 127]`` range.
  642. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SRGB_PACK32:
  643. .. rst-class:: classref-enumeration-constant
  644. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SRGB_PACK32** = ``56``
  645. 8-bit-per-channel unsigned floating-point alpha/red/green/blue channel data format with normalized value and non-linear sRGB encoding, packed in 32 bits. Values are in the ``[0.0, 1.0]`` range.
  646. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UNORM_PACK32:
  647. .. rst-class:: classref-enumeration-constant
  648. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_UNORM_PACK32** = ``57``
  649. Unsigned floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the ``[0.0, 1.0]`` range.
  650. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SNORM_PACK32:
  651. .. rst-class:: classref-enumeration-constant
  652. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_SNORM_PACK32** = ``58``
  653. Signed floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the ``[-1.0, 1.0]`` range.
  654. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_USCALED_PACK32:
  655. .. rst-class:: classref-enumeration-constant
  656. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_USCALED_PACK32** = ``59``
  657. Unsigned floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the ``[0.0, 1023.0]`` range for red/green/blue and ``[0.0, 3.0]`` for alpha.
  658. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SSCALED_PACK32:
  659. .. rst-class:: classref-enumeration-constant
  660. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_SSCALED_PACK32** = ``60``
  661. Signed floating-point alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the ``[-511.0, 511.0]`` range for red/green/blue and ``[-1.0, 1.0]`` for alpha.
  662. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UINT_PACK32:
  663. .. rst-class:: classref-enumeration-constant
  664. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_UINT_PACK32** = ``61``
  665. Unsigned integer alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the ``[0, 1023]`` range for red/green/blue and ``[0, 3]`` for alpha.
  666. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SINT_PACK32:
  667. .. rst-class:: classref-enumeration-constant
  668. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_SINT_PACK32** = ``62``
  669. Signed integer alpha/red/green/blue channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of red, 10 bits of green and 10 bits of blue. Values are in the ``[-511, 511]`` range for red/green/blue and ``[-1, 1]`` for alpha.
  670. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UNORM_PACK32:
  671. .. rst-class:: classref-enumeration-constant
  672. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_UNORM_PACK32** = ``63``
  673. Unsigned floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the ``[0.0, 1.0]`` range.
  674. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SNORM_PACK32:
  675. .. rst-class:: classref-enumeration-constant
  676. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_SNORM_PACK32** = ``64``
  677. Signed floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the ``[-1.0, 1.0]`` range.
  678. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_USCALED_PACK32:
  679. .. rst-class:: classref-enumeration-constant
  680. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_USCALED_PACK32** = ``65``
  681. Unsigned floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the ``[0.0, 1023.0]`` range for blue/green/red and ``[0.0, 3.0]`` for alpha.
  682. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SSCALED_PACK32:
  683. .. rst-class:: classref-enumeration-constant
  684. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_SSCALED_PACK32** = ``66``
  685. Signed floating-point alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the ``[-511.0, 511.0]`` range for blue/green/red and ``[-1.0, 1.0]`` for alpha.
  686. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UINT_PACK32:
  687. .. rst-class:: classref-enumeration-constant
  688. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_UINT_PACK32** = ``67``
  689. Unsigned integer alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the ``[0, 1023]`` range for blue/green/red and ``[0, 3]`` for alpha.
  690. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SINT_PACK32:
  691. .. rst-class:: classref-enumeration-constant
  692. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_SINT_PACK32** = ``68``
  693. Signed integer alpha/blue/green/red channel data format with normalized value, packed in 32 bits. Format contains 2 bits of alpha, 10 bits of blue, 10 bits of green and 10 bits of red. Values are in the ``[-511, 511]`` range for blue/green/red and ``[-1, 1]`` for alpha.
  694. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UNORM:
  695. .. rst-class:: classref-enumeration-constant
  696. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_UNORM** = ``69``
  697. 16-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  698. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SNORM:
  699. .. rst-class:: classref-enumeration-constant
  700. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SNORM** = ``70``
  701. 16-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  702. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_USCALED:
  703. .. rst-class:: classref-enumeration-constant
  704. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_USCALED** = ``71``
  705. 16-bit-per-channel unsigned floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 65535.0]`` range.
  706. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SSCALED:
  707. .. rst-class:: classref-enumeration-constant
  708. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SSCALED** = ``72``
  709. 16-bit-per-channel signed floating-point red channel data format with scaled value (value is converted from integer to float). Values are in the ``[-32767.0, 32767.0]`` range.
  710. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UINT:
  711. .. rst-class:: classref-enumeration-constant
  712. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_UINT** = ``73``
  713. 16-bit-per-channel unsigned integer red channel data format. Values are in the ``[0.0, 65535]`` range.
  714. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SINT:
  715. .. rst-class:: classref-enumeration-constant
  716. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SINT** = ``74``
  717. 16-bit-per-channel signed integer red channel data format. Values are in the ``[-32767, 32767]`` range.
  718. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SFLOAT:
  719. .. rst-class:: classref-enumeration-constant
  720. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SFLOAT** = ``75``
  721. 16-bit-per-channel signed floating-point red channel data format with the value stored as-is.
  722. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UNORM:
  723. .. rst-class:: classref-enumeration-constant
  724. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_UNORM** = ``76``
  725. 16-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  726. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SNORM:
  727. .. rst-class:: classref-enumeration-constant
  728. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SNORM** = ``77``
  729. 16-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  730. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_USCALED:
  731. .. rst-class:: classref-enumeration-constant
  732. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_USCALED** = ``78``
  733. 16-bit-per-channel unsigned floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 65535.0]`` range.
  734. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SSCALED:
  735. .. rst-class:: classref-enumeration-constant
  736. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SSCALED** = ``79``
  737. 16-bit-per-channel signed floating-point red/green channel data format with scaled value (value is converted from integer to float). Values are in the ``[-32767.0, 32767.0]`` range.
  738. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UINT:
  739. .. rst-class:: classref-enumeration-constant
  740. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_UINT** = ``80``
  741. 16-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0.0, 65535]`` range.
  742. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SINT:
  743. .. rst-class:: classref-enumeration-constant
  744. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SINT** = ``81``
  745. 16-bit-per-channel signed integer red/green channel data format. Values are in the ``[-32767, 32767]`` range.
  746. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SFLOAT:
  747. .. rst-class:: classref-enumeration-constant
  748. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SFLOAT** = ``82``
  749. 16-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
  750. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UNORM:
  751. .. rst-class:: classref-enumeration-constant
  752. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_UNORM** = ``83``
  753. 16-bit-per-channel unsigned floating-point red/green/blue channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  754. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SNORM:
  755. .. rst-class:: classref-enumeration-constant
  756. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SNORM** = ``84``
  757. 16-bit-per-channel signed floating-point red/green/blue channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  758. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_USCALED:
  759. .. rst-class:: classref-enumeration-constant
  760. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_USCALED** = ``85``
  761. 16-bit-per-channel unsigned floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 65535.0]`` range.
  762. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SSCALED:
  763. .. rst-class:: classref-enumeration-constant
  764. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SSCALED** = ``86``
  765. 16-bit-per-channel signed floating-point red/green/blue channel data format with scaled value (value is converted from integer to float). Values are in the ``[-32767.0, 32767.0]`` range.
  766. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UINT:
  767. .. rst-class:: classref-enumeration-constant
  768. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_UINT** = ``87``
  769. 16-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0.0, 65535]`` range.
  770. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SINT:
  771. .. rst-class:: classref-enumeration-constant
  772. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SINT** = ``88``
  773. 16-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[-32767, 32767]`` range.
  774. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SFLOAT:
  775. .. rst-class:: classref-enumeration-constant
  776. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SFLOAT** = ``89``
  777. 16-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
  778. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UNORM:
  779. .. rst-class:: classref-enumeration-constant
  780. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_UNORM** = ``90``
  781. 16-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  782. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SNORM:
  783. .. rst-class:: classref-enumeration-constant
  784. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SNORM** = ``91``
  785. 16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  786. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_USCALED:
  787. .. rst-class:: classref-enumeration-constant
  788. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_USCALED** = ``92``
  789. 16-bit-per-channel unsigned floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the ``[0.0, 65535.0]`` range.
  790. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SSCALED:
  791. .. rst-class:: classref-enumeration-constant
  792. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SSCALED** = ``93``
  793. 16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with scaled value (value is converted from integer to float). Values are in the ``[-32767.0, 32767.0]`` range.
  794. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UINT:
  795. .. rst-class:: classref-enumeration-constant
  796. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_UINT** = ``94``
  797. 16-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0.0, 65535]`` range.
  798. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SINT:
  799. .. rst-class:: classref-enumeration-constant
  800. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SINT** = ``95``
  801. 16-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[-32767, 32767]`` range.
  802. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SFLOAT:
  803. .. rst-class:: classref-enumeration-constant
  804. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SFLOAT** = ``96``
  805. 16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
  806. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_UINT:
  807. .. rst-class:: classref-enumeration-constant
  808. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32_UINT** = ``97``
  809. 32-bit-per-channel unsigned integer red channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  810. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SINT:
  811. .. rst-class:: classref-enumeration-constant
  812. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32_SINT** = ``98``
  813. 32-bit-per-channel signed integer red channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  814. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SFLOAT:
  815. .. rst-class:: classref-enumeration-constant
  816. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32_SFLOAT** = ``99``
  817. 32-bit-per-channel signed floating-point red channel data format with the value stored as-is.
  818. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_UINT:
  819. .. rst-class:: classref-enumeration-constant
  820. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32_UINT** = ``100``
  821. 32-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  822. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SINT:
  823. .. rst-class:: classref-enumeration-constant
  824. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32_SINT** = ``101``
  825. 32-bit-per-channel signed integer red/green channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  826. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SFLOAT:
  827. .. rst-class:: classref-enumeration-constant
  828. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32_SFLOAT** = ``102``
  829. 32-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
  830. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_UINT:
  831. .. rst-class:: classref-enumeration-constant
  832. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32_UINT** = ``103``
  833. 32-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  834. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SINT:
  835. .. rst-class:: classref-enumeration-constant
  836. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32_SINT** = ``104``
  837. 32-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  838. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SFLOAT:
  839. .. rst-class:: classref-enumeration-constant
  840. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32_SFLOAT** = ``105``
  841. 32-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
  842. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_UINT:
  843. .. rst-class:: classref-enumeration-constant
  844. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32A32_UINT** = ``106``
  845. 32-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  846. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SINT:
  847. .. rst-class:: classref-enumeration-constant
  848. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32A32_SINT** = ``107``
  849. 32-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  850. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SFLOAT:
  851. .. rst-class:: classref-enumeration-constant
  852. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32A32_SFLOAT** = ``108``
  853. 32-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
  854. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_UINT:
  855. .. rst-class:: classref-enumeration-constant
  856. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64_UINT** = ``109``
  857. 64-bit-per-channel unsigned integer red channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  858. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SINT:
  859. .. rst-class:: classref-enumeration-constant
  860. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64_SINT** = ``110``
  861. 64-bit-per-channel signed integer red channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  862. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SFLOAT:
  863. .. rst-class:: classref-enumeration-constant
  864. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64_SFLOAT** = ``111``
  865. 64-bit-per-channel signed floating-point red channel data format with the value stored as-is.
  866. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_UINT:
  867. .. rst-class:: classref-enumeration-constant
  868. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64_UINT** = ``112``
  869. 64-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  870. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SINT:
  871. .. rst-class:: classref-enumeration-constant
  872. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64_SINT** = ``113``
  873. 64-bit-per-channel signed integer red/green channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  874. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SFLOAT:
  875. .. rst-class:: classref-enumeration-constant
  876. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64_SFLOAT** = ``114``
  877. 64-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
  878. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_UINT:
  879. .. rst-class:: classref-enumeration-constant
  880. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64_UINT** = ``115``
  881. 64-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  882. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SINT:
  883. .. rst-class:: classref-enumeration-constant
  884. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64_SINT** = ``116``
  885. 64-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  886. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SFLOAT:
  887. .. rst-class:: classref-enumeration-constant
  888. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64_SFLOAT** = ``117``
  889. 64-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
  890. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_UINT:
  891. .. rst-class:: classref-enumeration-constant
  892. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64A64_UINT** = ``118``
  893. 64-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  894. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SINT:
  895. .. rst-class:: classref-enumeration-constant
  896. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64A64_SINT** = ``119``
  897. 64-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  898. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SFLOAT:
  899. .. rst-class:: classref-enumeration-constant
  900. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64A64_SFLOAT** = ``120``
  901. 64-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
  902. .. _class_RenderingDevice_constant_DATA_FORMAT_B10G11R11_UFLOAT_PACK32:
  903. .. rst-class:: classref-enumeration-constant
  904. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B10G11R11_UFLOAT_PACK32** = ``121``
  905. Unsigned floating-point blue/green/red data format with the value stored as-is, packed in 32 bits. The format's precision is 10 bits of blue channel, 11 bits of green channel and 11 bits of red channel.
  906. .. _class_RenderingDevice_constant_DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32:
  907. .. rst-class:: classref-enumeration-constant
  908. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32** = ``122``
  909. Unsigned floating-point exposure/blue/green/red data format with the value stored as-is, packed in 32 bits. The format's precision is 5 bits of exposure, 9 bits of blue channel, 9 bits of green channel and 9 bits of red channel.
  910. .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM:
  911. .. rst-class:: classref-enumeration-constant
  912. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D16_UNORM** = ``123``
  913. 16-bit unsigned floating-point depth data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  914. .. _class_RenderingDevice_constant_DATA_FORMAT_X8_D24_UNORM_PACK32:
  915. .. rst-class:: classref-enumeration-constant
  916. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_X8_D24_UNORM_PACK32** = ``124``
  917. 24-bit unsigned floating-point depth data format with normalized value, plus 8 unused bits, packed in 32 bits. Values for depth are in the ``[0.0, 1.0]`` range.
  918. .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT:
  919. .. rst-class:: classref-enumeration-constant
  920. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D32_SFLOAT** = ``125``
  921. 32-bit signed floating-point depth data format with the value stored as-is.
  922. .. _class_RenderingDevice_constant_DATA_FORMAT_S8_UINT:
  923. .. rst-class:: classref-enumeration-constant
  924. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_S8_UINT** = ``126``
  925. 8-bit unsigned integer stencil data format.
  926. .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM_S8_UINT:
  927. .. rst-class:: classref-enumeration-constant
  928. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D16_UNORM_S8_UINT** = ``127``
  929. 16-bit unsigned floating-point depth data format with normalized value, plus 8 bits of stencil in unsigned integer format. Values for depth are in the ``[0.0, 1.0]`` range. Values for stencil are in the ``[0, 255]`` range.
  930. .. _class_RenderingDevice_constant_DATA_FORMAT_D24_UNORM_S8_UINT:
  931. .. rst-class:: classref-enumeration-constant
  932. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D24_UNORM_S8_UINT** = ``128``
  933. 24-bit unsigned floating-point depth data format with normalized value, plus 8 bits of stencil in unsigned integer format. Values for depth are in the ``[0.0, 1.0]`` range. Values for stencil are in the ``[0, 255]`` range.
  934. .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT_S8_UINT:
  935. .. rst-class:: classref-enumeration-constant
  936. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D32_SFLOAT_S8_UINT** = ``129``
  937. 32-bit signed floating-point depth data format with the value stored as-is, plus 8 bits of stencil in unsigned integer format. Values for stencil are in the ``[0, 255]`` range.
  938. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_UNORM_BLOCK:
  939. .. rst-class:: classref-enumeration-constant
  940. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGB_UNORM_BLOCK** = ``130``
  941. VRAM-compressed unsigned red/green/blue channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. The format's precision is 5 bits of red channel, 6 bits of green channel and 5 bits of blue channel. Using BC1 texture compression (also known as S3TC DXT1).
  942. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_SRGB_BLOCK:
  943. .. rst-class:: classref-enumeration-constant
  944. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGB_SRGB_BLOCK** = ``131``
  945. VRAM-compressed unsigned red/green/blue channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. The format's precision is 5 bits of red channel, 6 bits of green channel and 5 bits of blue channel. Using BC1 texture compression (also known as S3TC DXT1).
  946. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_UNORM_BLOCK:
  947. .. rst-class:: classref-enumeration-constant
  948. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGBA_UNORM_BLOCK** = ``132``
  949. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 1 bit of alpha channel. Using BC1 texture compression (also known as S3TC DXT1).
  950. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_SRGB_BLOCK:
  951. .. rst-class:: classref-enumeration-constant
  952. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGBA_SRGB_BLOCK** = ``133``
  953. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 1 bit of alpha channel. Using BC1 texture compression (also known as S3TC DXT1).
  954. .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_UNORM_BLOCK:
  955. .. rst-class:: classref-enumeration-constant
  956. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC2_UNORM_BLOCK** = ``134``
  957. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 4 bits of alpha channel. Using BC2 texture compression (also known as S3TC DXT3).
  958. .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_SRGB_BLOCK:
  959. .. rst-class:: classref-enumeration-constant
  960. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC2_SRGB_BLOCK** = ``135``
  961. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 4 bits of alpha channel. Using BC2 texture compression (also known as S3TC DXT3).
  962. .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_UNORM_BLOCK:
  963. .. rst-class:: classref-enumeration-constant
  964. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC3_UNORM_BLOCK** = ``136``
  965. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 8 bits of alpha channel. Using BC3 texture compression (also known as S3TC DXT5).
  966. .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_SRGB_BLOCK:
  967. .. rst-class:: classref-enumeration-constant
  968. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC3_SRGB_BLOCK** = ``137``
  969. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. The format's precision is 5 bits of red channel, 6 bits of green channel, 5 bits of blue channel and 8 bits of alpha channel. Using BC3 texture compression (also known as S3TC DXT5).
  970. .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_UNORM_BLOCK:
  971. .. rst-class:: classref-enumeration-constant
  972. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC4_UNORM_BLOCK** = ``138``
  973. VRAM-compressed unsigned red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. The format's precision is 8 bits of red channel. Using BC4 texture compression.
  974. .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_SNORM_BLOCK:
  975. .. rst-class:: classref-enumeration-constant
  976. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC4_SNORM_BLOCK** = ``139``
  977. VRAM-compressed signed red channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range. The format's precision is 8 bits of red channel. Using BC4 texture compression.
  978. .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_UNORM_BLOCK:
  979. .. rst-class:: classref-enumeration-constant
  980. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC5_UNORM_BLOCK** = ``140``
  981. VRAM-compressed unsigned red/green channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. The format's precision is 8 bits of red channel and 8 bits of green channel. Using BC5 texture compression (also known as S3TC RGTC).
  982. .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_SNORM_BLOCK:
  983. .. rst-class:: classref-enumeration-constant
  984. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC5_SNORM_BLOCK** = ``141``
  985. VRAM-compressed signed red/green channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range. The format's precision is 8 bits of red channel and 8 bits of green channel. Using BC5 texture compression (also known as S3TC RGTC).
  986. .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_UFLOAT_BLOCK:
  987. .. rst-class:: classref-enumeration-constant
  988. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC6H_UFLOAT_BLOCK** = ``142``
  989. VRAM-compressed unsigned red/green/blue channel data format with the floating-point value stored as-is. The format's precision is between 10 and 13 bits for the red/green/blue channels. Using BC6H texture compression (also known as BPTC HDR).
  990. .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_SFLOAT_BLOCK:
  991. .. rst-class:: classref-enumeration-constant
  992. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC6H_SFLOAT_BLOCK** = ``143``
  993. VRAM-compressed signed red/green/blue channel data format with the floating-point value stored as-is. The format's precision is between 10 and 13 bits for the red/green/blue channels. Using BC6H texture compression (also known as BPTC HDR).
  994. .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_UNORM_BLOCK:
  995. .. rst-class:: classref-enumeration-constant
  996. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC7_UNORM_BLOCK** = ``144``
  997. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. The format's precision is between 4 and 7 bits for the red/green/blue channels and between 0 and 8 bits for the alpha channel. Also known as BPTC LDR.
  998. .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_SRGB_BLOCK:
  999. .. rst-class:: classref-enumeration-constant
  1000. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC7_SRGB_BLOCK** = ``145``
  1001. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. The format's precision is between 4 and 7 bits for the red/green/blue channels and between 0 and 8 bits for the alpha channel. Also known as BPTC LDR.
  1002. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK:
  1003. .. rst-class:: classref-enumeration-constant
  1004. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK** = ``146``
  1005. VRAM-compressed unsigned red/green/blue channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Using ETC2 texture compression.
  1006. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK:
  1007. .. rst-class:: classref-enumeration-constant
  1008. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK** = ``147``
  1009. VRAM-compressed unsigned red/green/blue channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. Using ETC2 texture compression.
  1010. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK:
  1011. .. rst-class:: classref-enumeration-constant
  1012. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK** = ``148``
  1013. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Red/green/blue use 8 bit of precision each, with alpha using 1 bit of precision. Using ETC2 texture compression.
  1014. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK:
  1015. .. rst-class:: classref-enumeration-constant
  1016. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK** = ``149``
  1017. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. Red/green/blue use 8 bit of precision each, with alpha using 1 bit of precision. Using ETC2 texture compression.
  1018. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK:
  1019. .. rst-class:: classref-enumeration-constant
  1020. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK** = ``150``
  1021. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Red/green/blue use 8 bits of precision each, with alpha using 8 bits of precision. Using ETC2 texture compression.
  1022. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK:
  1023. .. rst-class:: classref-enumeration-constant
  1024. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK** = ``151``
  1025. VRAM-compressed unsigned red/green/blue/alpha channel data format with normalized value and non-linear sRGB encoding. Values are in the ``[0.0, 1.0]`` range. Red/green/blue use 8 bits of precision each, with alpha using 8 bits of precision. Using ETC2 texture compression.
  1026. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_UNORM_BLOCK:
  1027. .. rst-class:: classref-enumeration-constant
  1028. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11_UNORM_BLOCK** = ``152``
  1029. 11-bit VRAM-compressed unsigned red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Using ETC2 texture compression.
  1030. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_SNORM_BLOCK:
  1031. .. rst-class:: classref-enumeration-constant
  1032. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11_SNORM_BLOCK** = ``153``
  1033. 11-bit VRAM-compressed signed red channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range. Using ETC2 texture compression.
  1034. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_UNORM_BLOCK:
  1035. .. rst-class:: classref-enumeration-constant
  1036. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11G11_UNORM_BLOCK** = ``154``
  1037. 11-bit VRAM-compressed unsigned red/green channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Using ETC2 texture compression.
  1038. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_SNORM_BLOCK:
  1039. .. rst-class:: classref-enumeration-constant
  1040. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11G11_SNORM_BLOCK** = ``155``
  1041. 11-bit VRAM-compressed signed red/green channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range. Using ETC2 texture compression.
  1042. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_UNORM_BLOCK:
  1043. .. rst-class:: classref-enumeration-constant
  1044. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_4x4_UNORM_BLOCK** = ``156``
  1045. VRAM-compressed unsigned floating-point data format with normalized value, packed in 4ร—4 blocks (highest quality). Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1046. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_SRGB_BLOCK:
  1047. .. rst-class:: classref-enumeration-constant
  1048. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_4x4_SRGB_BLOCK** = ``157``
  1049. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 4ร—4 blocks (highest quality). Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1050. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_UNORM_BLOCK:
  1051. .. rst-class:: classref-enumeration-constant
  1052. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x4_UNORM_BLOCK** = ``158``
  1053. VRAM-compressed unsigned floating-point data format with normalized value, packed in 5ร—4 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1054. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_SRGB_BLOCK:
  1055. .. rst-class:: classref-enumeration-constant
  1056. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x4_SRGB_BLOCK** = ``159``
  1057. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 5ร—4 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1058. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_UNORM_BLOCK:
  1059. .. rst-class:: classref-enumeration-constant
  1060. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x5_UNORM_BLOCK** = ``160``
  1061. VRAM-compressed unsigned floating-point data format with normalized value, packed in 5ร—5 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1062. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_SRGB_BLOCK:
  1063. .. rst-class:: classref-enumeration-constant
  1064. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x5_SRGB_BLOCK** = ``161``
  1065. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 5ร—5 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1066. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_UNORM_BLOCK:
  1067. .. rst-class:: classref-enumeration-constant
  1068. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x5_UNORM_BLOCK** = ``162``
  1069. VRAM-compressed unsigned floating-point data format with normalized value, packed in 6ร—5 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1070. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_SRGB_BLOCK:
  1071. .. rst-class:: classref-enumeration-constant
  1072. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x5_SRGB_BLOCK** = ``163``
  1073. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 6ร—5 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1074. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_UNORM_BLOCK:
  1075. .. rst-class:: classref-enumeration-constant
  1076. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x6_UNORM_BLOCK** = ``164``
  1077. VRAM-compressed unsigned floating-point data format with normalized value, packed in 6ร—6 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1078. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_SRGB_BLOCK:
  1079. .. rst-class:: classref-enumeration-constant
  1080. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x6_SRGB_BLOCK** = ``165``
  1081. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 6ร—6 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1082. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_UNORM_BLOCK:
  1083. .. rst-class:: classref-enumeration-constant
  1084. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x5_UNORM_BLOCK** = ``166``
  1085. VRAM-compressed unsigned floating-point data format with normalized value, packed in 8ร—5 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1086. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_SRGB_BLOCK:
  1087. .. rst-class:: classref-enumeration-constant
  1088. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x5_SRGB_BLOCK** = ``167``
  1089. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 8ร—5 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1090. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_UNORM_BLOCK:
  1091. .. rst-class:: classref-enumeration-constant
  1092. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x6_UNORM_BLOCK** = ``168``
  1093. VRAM-compressed unsigned floating-point data format with normalized value, packed in 8ร—6 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1094. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_SRGB_BLOCK:
  1095. .. rst-class:: classref-enumeration-constant
  1096. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x6_SRGB_BLOCK** = ``169``
  1097. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 8ร—6 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1098. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_UNORM_BLOCK:
  1099. .. rst-class:: classref-enumeration-constant
  1100. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x8_UNORM_BLOCK** = ``170``
  1101. VRAM-compressed unsigned floating-point data format with normalized value, packed in 8ร—8 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1102. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_SRGB_BLOCK:
  1103. .. rst-class:: classref-enumeration-constant
  1104. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x8_SRGB_BLOCK** = ``171``
  1105. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 8ร—8 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1106. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_UNORM_BLOCK:
  1107. .. rst-class:: classref-enumeration-constant
  1108. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x5_UNORM_BLOCK** = ``172``
  1109. VRAM-compressed unsigned floating-point data format with normalized value, packed in 10ร—5 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1110. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_SRGB_BLOCK:
  1111. .. rst-class:: classref-enumeration-constant
  1112. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x5_SRGB_BLOCK** = ``173``
  1113. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 10ร—5 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1114. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_UNORM_BLOCK:
  1115. .. rst-class:: classref-enumeration-constant
  1116. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x6_UNORM_BLOCK** = ``174``
  1117. VRAM-compressed unsigned floating-point data format with normalized value, packed in 10ร—6 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1118. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_SRGB_BLOCK:
  1119. .. rst-class:: classref-enumeration-constant
  1120. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x6_SRGB_BLOCK** = ``175``
  1121. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 10ร—6 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1122. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_UNORM_BLOCK:
  1123. .. rst-class:: classref-enumeration-constant
  1124. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x8_UNORM_BLOCK** = ``176``
  1125. VRAM-compressed unsigned floating-point data format with normalized value, packed in 10ร—8 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1126. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_SRGB_BLOCK:
  1127. .. rst-class:: classref-enumeration-constant
  1128. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x8_SRGB_BLOCK** = ``177``
  1129. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 10ร—8 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1130. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_UNORM_BLOCK:
  1131. .. rst-class:: classref-enumeration-constant
  1132. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x10_UNORM_BLOCK** = ``178``
  1133. VRAM-compressed unsigned floating-point data format with normalized value, packed in 10ร—10 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1134. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_SRGB_BLOCK:
  1135. .. rst-class:: classref-enumeration-constant
  1136. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x10_SRGB_BLOCK** = ``179``
  1137. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 10ร—10 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1138. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_UNORM_BLOCK:
  1139. .. rst-class:: classref-enumeration-constant
  1140. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x10_UNORM_BLOCK** = ``180``
  1141. VRAM-compressed unsigned floating-point data format with normalized value, packed in 12ร—10 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1142. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_SRGB_BLOCK:
  1143. .. rst-class:: classref-enumeration-constant
  1144. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x10_SRGB_BLOCK** = ``181``
  1145. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 12ร—10 blocks. Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1146. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_UNORM_BLOCK:
  1147. .. rst-class:: classref-enumeration-constant
  1148. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x12_UNORM_BLOCK** = ``182``
  1149. VRAM-compressed unsigned floating-point data format with normalized value, packed in 12 blocks (lowest quality). Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1150. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_SRGB_BLOCK:
  1151. .. rst-class:: classref-enumeration-constant
  1152. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x12_SRGB_BLOCK** = ``183``
  1153. VRAM-compressed unsigned floating-point data format with normalized value and non-linear sRGB encoding, packed in 12 blocks (lowest quality). Values are in the ``[0.0, 1.0]`` range. Using ASTC compression.
  1154. .. _class_RenderingDevice_constant_DATA_FORMAT_G8B8G8R8_422_UNORM:
  1155. .. rst-class:: classref-enumeration-constant
  1156. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8B8G8R8_422_UNORM** = ``184``
  1157. 8-bit-per-channel unsigned floating-point green/blue/red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1158. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8G8_422_UNORM:
  1159. .. rst-class:: classref-enumeration-constant
  1160. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8G8_422_UNORM** = ``185``
  1161. 8-bit-per-channel unsigned floating-point blue/green/red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1162. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM:
  1163. .. rst-class:: classref-enumeration-constant
  1164. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM** = ``186``
  1165. 8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 3 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2ร—2 adjacent pixels will share the same value for the blue/red channel).
  1166. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM:
  1167. .. rst-class:: classref-enumeration-constant
  1168. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM** = ``187``
  1169. 8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 2 separate planes (green + blue/red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2ร—2 adjacent pixels will share the same value for the blue/red channel).
  1170. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM:
  1171. .. rst-class:: classref-enumeration-constant
  1172. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM** = ``188``
  1173. 8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 2 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1174. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM:
  1175. .. rst-class:: classref-enumeration-constant
  1176. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM** = ``189``
  1177. 8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 2 separate planes (green + blue/red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1178. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM:
  1179. .. rst-class:: classref-enumeration-constant
  1180. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM** = ``190``
  1181. 8-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, stored across 3 separate planes. Values are in the ``[0.0, 1.0]`` range.
  1182. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6_UNORM_PACK16:
  1183. .. rst-class:: classref-enumeration-constant
  1184. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R10X6_UNORM_PACK16** = ``191``
  1185. 10-bit-per-channel unsigned floating-point red channel data with normalized value, plus 6 unused bits, packed in 16 bits. Values are in the ``[0.0, 1.0]`` range.
  1186. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6_UNORM_2PACK16:
  1187. .. rst-class:: classref-enumeration-constant
  1188. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R10X6G10X6_UNORM_2PACK16** = ``192``
  1189. 10-bit-per-channel unsigned floating-point red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 2ร—16 bits. Values are in the ``[0.0, 1.0]`` range.
  1190. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16:
  1191. .. rst-class:: classref-enumeration-constant
  1192. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16** = ``193``
  1193. 10-bit-per-channel unsigned floating-point red/green/blue/alpha channel data with normalized value, plus 6 unused bits after each channel, packed in 4ร—16 bits. Values are in the ``[0.0, 1.0]`` range.
  1194. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16:
  1195. .. rst-class:: classref-enumeration-constant
  1196. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16** = ``194``
  1197. 10-bit-per-channel unsigned floating-point green/blue/green/red channel data with normalized value, plus 6 unused bits after each channel, packed in 4ร—16 bits. Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel). The green channel is listed twice, but contains different values to allow it to be represented at full resolution.
  1198. .. _class_RenderingDevice_constant_DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16:
  1199. .. rst-class:: classref-enumeration-constant
  1200. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16** = ``195``
  1201. 10-bit-per-channel unsigned floating-point blue/green/red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 4ร—16 bits. Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel). The green channel is listed twice, but contains different values to allow it to be represented at full resolution.
  1202. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16:
  1203. .. rst-class:: classref-enumeration-constant
  1204. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16** = ``196``
  1205. 10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 2 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2ร—2 adjacent pixels will share the same value for the blue/red channel).
  1206. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16:
  1207. .. rst-class:: classref-enumeration-constant
  1208. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16** = ``197``
  1209. 10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 2 separate planes (green + blue/red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2ร—2 adjacent pixels will share the same value for the blue/red channel).
  1210. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16:
  1211. .. rst-class:: classref-enumeration-constant
  1212. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16** = ``198``
  1213. 10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 3 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1214. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16:
  1215. .. rst-class:: classref-enumeration-constant
  1216. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16** = ``199``
  1217. 10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 3 separate planes (green + blue/red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1218. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16:
  1219. .. rst-class:: classref-enumeration-constant
  1220. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16** = ``200``
  1221. 10-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 3 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range.
  1222. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4_UNORM_PACK16:
  1223. .. rst-class:: classref-enumeration-constant
  1224. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R12X4_UNORM_PACK16** = ``201``
  1225. 12-bit-per-channel unsigned floating-point red channel data with normalized value, plus 6 unused bits, packed in 16 bits. Values are in the ``[0.0, 1.0]`` range.
  1226. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4_UNORM_2PACK16:
  1227. .. rst-class:: classref-enumeration-constant
  1228. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R12X4G12X4_UNORM_2PACK16** = ``202``
  1229. 12-bit-per-channel unsigned floating-point red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 2ร—16 bits. Values are in the ``[0.0, 1.0]`` range.
  1230. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16:
  1231. .. rst-class:: classref-enumeration-constant
  1232. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16** = ``203``
  1233. 12-bit-per-channel unsigned floating-point red/green/blue/alpha channel data with normalized value, plus 6 unused bits after each channel, packed in 4ร—16 bits. Values are in the ``[0.0, 1.0]`` range.
  1234. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16:
  1235. .. rst-class:: classref-enumeration-constant
  1236. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16** = ``204``
  1237. 12-bit-per-channel unsigned floating-point green/blue/green/red channel data with normalized value, plus 6 unused bits after each channel, packed in 4ร—16 bits. Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel). The green channel is listed twice, but contains different values to allow it to be represented at full resolution.
  1238. .. _class_RenderingDevice_constant_DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16:
  1239. .. rst-class:: classref-enumeration-constant
  1240. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16** = ``205``
  1241. 12-bit-per-channel unsigned floating-point blue/green/red/green channel data with normalized value, plus 6 unused bits after each channel, packed in 4ร—16 bits. Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel). The green channel is listed twice, but contains different values to allow it to be represented at full resolution.
  1242. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16:
  1243. .. rst-class:: classref-enumeration-constant
  1244. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16** = ``206``
  1245. 12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 2 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2ร—2 adjacent pixels will share the same value for the blue/red channel).
  1246. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16:
  1247. .. rst-class:: classref-enumeration-constant
  1248. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16** = ``207``
  1249. 12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 2 separate planes (green + blue/red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2ร—2 adjacent pixels will share the same value for the blue/red channel).
  1250. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16:
  1251. .. rst-class:: classref-enumeration-constant
  1252. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16** = ``208``
  1253. 12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 3 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1254. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16:
  1255. .. rst-class:: classref-enumeration-constant
  1256. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16** = ``209``
  1257. 12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 3 separate planes (green + blue/red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1258. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16:
  1259. .. rst-class:: classref-enumeration-constant
  1260. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16** = ``210``
  1261. 12-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Packed in 3ร—16 bits and stored across 3 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range.
  1262. .. _class_RenderingDevice_constant_DATA_FORMAT_G16B16G16R16_422_UNORM:
  1263. .. rst-class:: classref-enumeration-constant
  1264. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16B16G16R16_422_UNORM** = ``211``
  1265. 16-bit-per-channel unsigned floating-point green/blue/red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1266. .. _class_RenderingDevice_constant_DATA_FORMAT_B16G16R16G16_422_UNORM:
  1267. .. rst-class:: classref-enumeration-constant
  1268. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B16G16R16G16_422_UNORM** = ``212``
  1269. 16-bit-per-channel unsigned floating-point blue/green/red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1270. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM:
  1271. .. rst-class:: classref-enumeration-constant
  1272. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM** = ``213``
  1273. 16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 2 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2ร—2 adjacent pixels will share the same value for the blue/red channel).
  1274. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM:
  1275. .. rst-class:: classref-enumeration-constant
  1276. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM** = ``214``
  1277. 16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 2 separate planes (green + blue/red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal and vertical resolution (i.e. 2ร—2 adjacent pixels will share the same value for the blue/red channel).
  1278. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM:
  1279. .. rst-class:: classref-enumeration-constant
  1280. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM** = ``215``
  1281. 16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1282. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM:
  1283. .. rst-class:: classref-enumeration-constant
  1284. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM** = ``216``
  1285. 16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue/red). Values are in the ``[0.0, 1.0]`` range. Blue and red channel data is stored at halved horizontal resolution (i.e. 2 horizontally adjacent pixels will share the same value for the blue/red channel).
  1286. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM:
  1287. .. rst-class:: classref-enumeration-constant
  1288. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM** = ``217``
  1289. 16-bit-per-channel unsigned floating-point green/blue/red channel data with normalized value, plus 6 unused bits after each channel. Stored across 3 separate planes (green + blue + red). Values are in the ``[0.0, 1.0]`` range.
  1290. .. _class_RenderingDevice_constant_DATA_FORMAT_MAX:
  1291. .. rst-class:: classref-enumeration-constant
  1292. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_MAX** = ``218``
  1293. Represents the size of the :ref:`DataFormat<enum_RenderingDevice_DataFormat>` enum.
  1294. .. rst-class:: classref-item-separator
  1295. ----
  1296. .. _enum_RenderingDevice_BarrierMask:
  1297. .. rst-class:: classref-enumeration
  1298. flags **BarrierMask**: :ref:`๐Ÿ”—<enum_RenderingDevice_BarrierMask>`
  1299. .. _class_RenderingDevice_constant_BARRIER_MASK_VERTEX:
  1300. .. rst-class:: classref-enumeration-constant
  1301. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_VERTEX** = ``1``
  1302. Vertex shader barrier mask.
  1303. .. _class_RenderingDevice_constant_BARRIER_MASK_FRAGMENT:
  1304. .. rst-class:: classref-enumeration-constant
  1305. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_FRAGMENT** = ``8``
  1306. Fragment shader barrier mask.
  1307. .. _class_RenderingDevice_constant_BARRIER_MASK_COMPUTE:
  1308. .. rst-class:: classref-enumeration-constant
  1309. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_COMPUTE** = ``2``
  1310. Compute barrier mask.
  1311. .. _class_RenderingDevice_constant_BARRIER_MASK_TRANSFER:
  1312. .. rst-class:: classref-enumeration-constant
  1313. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_TRANSFER** = ``4``
  1314. Transfer barrier mask.
  1315. .. _class_RenderingDevice_constant_BARRIER_MASK_RASTER:
  1316. .. rst-class:: classref-enumeration-constant
  1317. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_RASTER** = ``9``
  1318. Raster barrier mask (vertex and fragment). Equivalent to ``BARRIER_MASK_VERTEX | BARRIER_MASK_FRAGMENT``.
  1319. .. _class_RenderingDevice_constant_BARRIER_MASK_ALL_BARRIERS:
  1320. .. rst-class:: classref-enumeration-constant
  1321. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_ALL_BARRIERS** = ``32767``
  1322. Barrier mask for all types (vertex, fragment, compute, transfer).
  1323. .. _class_RenderingDevice_constant_BARRIER_MASK_NO_BARRIER:
  1324. .. rst-class:: classref-enumeration-constant
  1325. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_NO_BARRIER** = ``32768``
  1326. No barrier for any type.
  1327. .. rst-class:: classref-item-separator
  1328. ----
  1329. .. _enum_RenderingDevice_TextureType:
  1330. .. rst-class:: classref-enumeration
  1331. enum **TextureType**: :ref:`๐Ÿ”—<enum_RenderingDevice_TextureType>`
  1332. .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D:
  1333. .. rst-class:: classref-enumeration-constant
  1334. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_1D** = ``0``
  1335. 1-dimensional texture.
  1336. .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D:
  1337. .. rst-class:: classref-enumeration-constant
  1338. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_2D** = ``1``
  1339. 2-dimensional texture.
  1340. .. _class_RenderingDevice_constant_TEXTURE_TYPE_3D:
  1341. .. rst-class:: classref-enumeration-constant
  1342. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_3D** = ``2``
  1343. 3-dimensional texture.
  1344. .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE:
  1345. .. rst-class:: classref-enumeration-constant
  1346. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_CUBE** = ``3``
  1347. :ref:`Cubemap<class_Cubemap>` texture.
  1348. .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D_ARRAY:
  1349. .. rst-class:: classref-enumeration-constant
  1350. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_1D_ARRAY** = ``4``
  1351. Array of 1-dimensional textures.
  1352. .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D_ARRAY:
  1353. .. rst-class:: classref-enumeration-constant
  1354. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_2D_ARRAY** = ``5``
  1355. Array of 2-dimensional textures.
  1356. .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE_ARRAY:
  1357. .. rst-class:: classref-enumeration-constant
  1358. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_CUBE_ARRAY** = ``6``
  1359. Array of :ref:`Cubemap<class_Cubemap>` textures.
  1360. .. _class_RenderingDevice_constant_TEXTURE_TYPE_MAX:
  1361. .. rst-class:: classref-enumeration-constant
  1362. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_MAX** = ``7``
  1363. Represents the size of the :ref:`TextureType<enum_RenderingDevice_TextureType>` enum.
  1364. .. rst-class:: classref-item-separator
  1365. ----
  1366. .. _enum_RenderingDevice_TextureSamples:
  1367. .. rst-class:: classref-enumeration
  1368. enum **TextureSamples**: :ref:`๐Ÿ”—<enum_RenderingDevice_TextureSamples>`
  1369. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_1:
  1370. .. rst-class:: classref-enumeration-constant
  1371. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_1** = ``0``
  1372. Perform 1 texture sample (this is the fastest but lowest-quality for antialiasing).
  1373. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_2:
  1374. .. rst-class:: classref-enumeration-constant
  1375. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_2** = ``1``
  1376. Perform 2 texture samples.
  1377. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_4:
  1378. .. rst-class:: classref-enumeration-constant
  1379. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_4** = ``2``
  1380. Perform 4 texture samples.
  1381. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_8:
  1382. .. rst-class:: classref-enumeration-constant
  1383. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_8** = ``3``
  1384. Perform 8 texture samples. Not supported on mobile GPUs (including Apple Silicon).
  1385. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_16:
  1386. .. rst-class:: classref-enumeration-constant
  1387. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_16** = ``4``
  1388. Perform 16 texture samples. Not supported on mobile GPUs and many desktop GPUs.
  1389. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_32:
  1390. .. rst-class:: classref-enumeration-constant
  1391. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_32** = ``5``
  1392. Perform 32 texture samples. Not supported on most GPUs.
  1393. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_64:
  1394. .. rst-class:: classref-enumeration-constant
  1395. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_64** = ``6``
  1396. Perform 64 texture samples (this is the slowest but highest-quality for antialiasing). Not supported on most GPUs.
  1397. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_MAX:
  1398. .. rst-class:: classref-enumeration-constant
  1399. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_MAX** = ``7``
  1400. Represents the size of the :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` enum.
  1401. .. rst-class:: classref-item-separator
  1402. ----
  1403. .. _enum_RenderingDevice_TextureUsageBits:
  1404. .. rst-class:: classref-enumeration
  1405. flags **TextureUsageBits**: :ref:`๐Ÿ”—<enum_RenderingDevice_TextureUsageBits>`
  1406. .. _class_RenderingDevice_constant_TEXTURE_USAGE_SAMPLING_BIT:
  1407. .. rst-class:: classref-enumeration-constant
  1408. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_SAMPLING_BIT** = ``1``
  1409. Texture can be sampled.
  1410. .. _class_RenderingDevice_constant_TEXTURE_USAGE_COLOR_ATTACHMENT_BIT:
  1411. .. rst-class:: classref-enumeration-constant
  1412. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_COLOR_ATTACHMENT_BIT** = ``2``
  1413. Texture can be used as a color attachment in a framebuffer.
  1414. .. _class_RenderingDevice_constant_TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT:
  1415. .. rst-class:: classref-enumeration-constant
  1416. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT** = ``4``
  1417. Texture can be used as a depth/stencil attachment in a framebuffer.
  1418. .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_BIT:
  1419. .. rst-class:: classref-enumeration-constant
  1420. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_STORAGE_BIT** = ``8``
  1421. Texture can be used as a `storage image <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#descriptorsets-storageimage>`__.
  1422. .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_ATOMIC_BIT:
  1423. .. rst-class:: classref-enumeration-constant
  1424. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_STORAGE_ATOMIC_BIT** = ``16``
  1425. Texture can be used as a `storage image <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#descriptorsets-storageimage>`__ with support for atomic operations.
  1426. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CPU_READ_BIT:
  1427. .. rst-class:: classref-enumeration-constant
  1428. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CPU_READ_BIT** = ``32``
  1429. Texture can be read back on the CPU using :ref:`texture_get_data<class_RenderingDevice_method_texture_get_data>` faster than without this bit, since it is always kept in the system memory.
  1430. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_UPDATE_BIT:
  1431. .. rst-class:: classref-enumeration-constant
  1432. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CAN_UPDATE_BIT** = ``64``
  1433. Texture can be updated using :ref:`texture_update<class_RenderingDevice_method_texture_update>`.
  1434. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT:
  1435. .. rst-class:: classref-enumeration-constant
  1436. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CAN_COPY_FROM_BIT** = ``128``
  1437. Texture can be a source for :ref:`texture_copy<class_RenderingDevice_method_texture_copy>`.
  1438. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_TO_BIT:
  1439. .. rst-class:: classref-enumeration-constant
  1440. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CAN_COPY_TO_BIT** = ``256``
  1441. Texture can be a destination for :ref:`texture_copy<class_RenderingDevice_method_texture_copy>`.
  1442. .. _class_RenderingDevice_constant_TEXTURE_USAGE_INPUT_ATTACHMENT_BIT:
  1443. .. rst-class:: classref-enumeration-constant
  1444. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_INPUT_ATTACHMENT_BIT** = ``512``
  1445. Texture can be used as a `input attachment <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#descriptorsets-inputattachment>`__ in a framebuffer.
  1446. .. rst-class:: classref-item-separator
  1447. ----
  1448. .. _enum_RenderingDevice_TextureSwizzle:
  1449. .. rst-class:: classref-enumeration
  1450. enum **TextureSwizzle**: :ref:`๐Ÿ”—<enum_RenderingDevice_TextureSwizzle>`
  1451. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_IDENTITY:
  1452. .. rst-class:: classref-enumeration-constant
  1453. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_IDENTITY** = ``0``
  1454. Return the sampled value as-is.
  1455. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ZERO:
  1456. .. rst-class:: classref-enumeration-constant
  1457. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_ZERO** = ``1``
  1458. Always return ``0.0`` when sampling.
  1459. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ONE:
  1460. .. rst-class:: classref-enumeration-constant
  1461. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_ONE** = ``2``
  1462. Always return ``1.0`` when sampling.
  1463. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_R:
  1464. .. rst-class:: classref-enumeration-constant
  1465. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_R** = ``3``
  1466. Sample the red color channel.
  1467. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_G:
  1468. .. rst-class:: classref-enumeration-constant
  1469. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_G** = ``4``
  1470. Sample the green color channel.
  1471. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_B:
  1472. .. rst-class:: classref-enumeration-constant
  1473. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_B** = ``5``
  1474. Sample the blue color channel.
  1475. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_A:
  1476. .. rst-class:: classref-enumeration-constant
  1477. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_A** = ``6``
  1478. Sample the alpha channel.
  1479. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_MAX:
  1480. .. rst-class:: classref-enumeration-constant
  1481. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_MAX** = ``7``
  1482. Represents the size of the :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` enum.
  1483. .. rst-class:: classref-item-separator
  1484. ----
  1485. .. _enum_RenderingDevice_TextureSliceType:
  1486. .. rst-class:: classref-enumeration
  1487. enum **TextureSliceType**: :ref:`๐Ÿ”—<enum_RenderingDevice_TextureSliceType>`
  1488. .. _class_RenderingDevice_constant_TEXTURE_SLICE_2D:
  1489. .. rst-class:: classref-enumeration-constant
  1490. :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` **TEXTURE_SLICE_2D** = ``0``
  1491. 2-dimensional texture slice.
  1492. .. _class_RenderingDevice_constant_TEXTURE_SLICE_CUBEMAP:
  1493. .. rst-class:: classref-enumeration-constant
  1494. :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` **TEXTURE_SLICE_CUBEMAP** = ``1``
  1495. Cubemap texture slice.
  1496. .. _class_RenderingDevice_constant_TEXTURE_SLICE_3D:
  1497. .. rst-class:: classref-enumeration-constant
  1498. :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` **TEXTURE_SLICE_3D** = ``2``
  1499. 3-dimensional texture slice.
  1500. .. rst-class:: classref-item-separator
  1501. ----
  1502. .. _enum_RenderingDevice_SamplerFilter:
  1503. .. rst-class:: classref-enumeration
  1504. enum **SamplerFilter**: :ref:`๐Ÿ”—<enum_RenderingDevice_SamplerFilter>`
  1505. .. _class_RenderingDevice_constant_SAMPLER_FILTER_NEAREST:
  1506. .. rst-class:: classref-enumeration-constant
  1507. :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>` **SAMPLER_FILTER_NEAREST** = ``0``
  1508. Nearest-neighbor sampler filtering. Sampling at higher resolutions than the source will result in a pixelated look.
  1509. .. _class_RenderingDevice_constant_SAMPLER_FILTER_LINEAR:
  1510. .. rst-class:: classref-enumeration-constant
  1511. :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>` **SAMPLER_FILTER_LINEAR** = ``1``
  1512. Bilinear sampler filtering. Sampling at higher resolutions than the source will result in a blurry look.
  1513. .. rst-class:: classref-item-separator
  1514. ----
  1515. .. _enum_RenderingDevice_SamplerRepeatMode:
  1516. .. rst-class:: classref-enumeration
  1517. enum **SamplerRepeatMode**: :ref:`๐Ÿ”—<enum_RenderingDevice_SamplerRepeatMode>`
  1518. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_REPEAT:
  1519. .. rst-class:: classref-enumeration-constant
  1520. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_REPEAT** = ``0``
  1521. Sample with repeating enabled.
  1522. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRRORED_REPEAT:
  1523. .. rst-class:: classref-enumeration-constant
  1524. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_MIRRORED_REPEAT** = ``1``
  1525. Sample with mirrored repeating enabled. When sampling outside the ``[0.0, 1.0]`` range, return a mirrored version of the sampler. This mirrored version is mirrored again if sampling further away, with the pattern repeating indefinitely.
  1526. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE:
  1527. .. rst-class:: classref-enumeration-constant
  1528. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE** = ``2``
  1529. Sample with repeating disabled. When sampling outside the ``[0.0, 1.0]`` range, return the color of the last pixel on the edge.
  1530. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER:
  1531. .. rst-class:: classref-enumeration-constant
  1532. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER** = ``3``
  1533. Sample with repeating disabled. When sampling outside the ``[0.0, 1.0]`` range, return the specified :ref:`RDSamplerState.border_color<class_RDSamplerState_property_border_color>`.
  1534. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE:
  1535. .. rst-class:: classref-enumeration-constant
  1536. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE** = ``4``
  1537. Sample with mirrored repeating enabled, but only once. When sampling in the ``[-1.0, 0.0]`` range, return a mirrored version of the sampler. When sampling outside the ``[-1.0, 1.0]`` range, return the color of the last pixel on the edge.
  1538. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MAX:
  1539. .. rst-class:: classref-enumeration-constant
  1540. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_MAX** = ``5``
  1541. Represents the size of the :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` enum.
  1542. .. rst-class:: classref-item-separator
  1543. ----
  1544. .. _enum_RenderingDevice_SamplerBorderColor:
  1545. .. rst-class:: classref-enumeration
  1546. enum **SamplerBorderColor**: :ref:`๐Ÿ”—<enum_RenderingDevice_SamplerBorderColor>`
  1547. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK:
  1548. .. rst-class:: classref-enumeration-constant
  1549. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK** = ``0``
  1550. Return a floating-point transparent black color when sampling outside the ``[0.0, 1.0]`` range. Only effective if the sampler repeat mode is :ref:`SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER<class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER>`.
  1551. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK:
  1552. .. rst-class:: classref-enumeration-constant
  1553. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK** = ``1``
  1554. Return a integer transparent black color when sampling outside the ``[0.0, 1.0]`` range. Only effective if the sampler repeat mode is :ref:`SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER<class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER>`.
  1555. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK:
  1556. .. rst-class:: classref-enumeration-constant
  1557. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK** = ``2``
  1558. Return a floating-point opaque black color when sampling outside the ``[0.0, 1.0]`` range. Only effective if the sampler repeat mode is :ref:`SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER<class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER>`.
  1559. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK:
  1560. .. rst-class:: classref-enumeration-constant
  1561. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK** = ``3``
  1562. Return a integer opaque black color when sampling outside the ``[0.0, 1.0]`` range. Only effective if the sampler repeat mode is :ref:`SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER<class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER>`.
  1563. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE:
  1564. .. rst-class:: classref-enumeration-constant
  1565. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE** = ``4``
  1566. Return a floating-point opaque white color when sampling outside the ``[0.0, 1.0]`` range. Only effective if the sampler repeat mode is :ref:`SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER<class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER>`.
  1567. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE:
  1568. .. rst-class:: classref-enumeration-constant
  1569. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE** = ``5``
  1570. Return a integer opaque white color when sampling outside the ``[0.0, 1.0]`` range. Only effective if the sampler repeat mode is :ref:`SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER<class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER>`.
  1571. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_MAX:
  1572. .. rst-class:: classref-enumeration-constant
  1573. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_MAX** = ``6``
  1574. Represents the size of the :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` enum.
  1575. .. rst-class:: classref-item-separator
  1576. ----
  1577. .. _enum_RenderingDevice_VertexFrequency:
  1578. .. rst-class:: classref-enumeration
  1579. enum **VertexFrequency**: :ref:`๐Ÿ”—<enum_RenderingDevice_VertexFrequency>`
  1580. .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_VERTEX:
  1581. .. rst-class:: classref-enumeration-constant
  1582. :ref:`VertexFrequency<enum_RenderingDevice_VertexFrequency>` **VERTEX_FREQUENCY_VERTEX** = ``0``
  1583. Vertex attribute addressing is a function of the vertex. This is used to specify the rate at which vertex attributes are pulled from buffers.
  1584. .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_INSTANCE:
  1585. .. rst-class:: classref-enumeration-constant
  1586. :ref:`VertexFrequency<enum_RenderingDevice_VertexFrequency>` **VERTEX_FREQUENCY_INSTANCE** = ``1``
  1587. Vertex attribute addressing is a function of the instance index. This is used to specify the rate at which vertex attributes are pulled from buffers.
  1588. .. rst-class:: classref-item-separator
  1589. ----
  1590. .. _enum_RenderingDevice_IndexBufferFormat:
  1591. .. rst-class:: classref-enumeration
  1592. enum **IndexBufferFormat**: :ref:`๐Ÿ”—<enum_RenderingDevice_IndexBufferFormat>`
  1593. .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT16:
  1594. .. rst-class:: classref-enumeration-constant
  1595. :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` **INDEX_BUFFER_FORMAT_UINT16** = ``0``
  1596. Index buffer in 16-bit unsigned integer format. This limits the maximum index that can be specified to ``65535``.
  1597. .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT32:
  1598. .. rst-class:: classref-enumeration-constant
  1599. :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` **INDEX_BUFFER_FORMAT_UINT32** = ``1``
  1600. Index buffer in 32-bit unsigned integer format. This limits the maximum index that can be specified to ``4294967295``.
  1601. .. rst-class:: classref-item-separator
  1602. ----
  1603. .. _enum_RenderingDevice_StorageBufferUsage:
  1604. .. rst-class:: classref-enumeration
  1605. flags **StorageBufferUsage**: :ref:`๐Ÿ”—<enum_RenderingDevice_StorageBufferUsage>`
  1606. .. _class_RenderingDevice_constant_STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT:
  1607. .. rst-class:: classref-enumeration-constant
  1608. :ref:`StorageBufferUsage<enum_RenderingDevice_StorageBufferUsage>` **STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT** = ``1``
  1609. .. container:: contribute
  1610. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  1611. .. _class_RenderingDevice_constant_STORAGE_BUFFER_USAGE_DEVICE_ADDRESS:
  1612. .. rst-class:: classref-enumeration-constant
  1613. :ref:`StorageBufferUsage<enum_RenderingDevice_StorageBufferUsage>` **STORAGE_BUFFER_USAGE_DEVICE_ADDRESS** = ``2``
  1614. Allows usage of :ref:`buffer_get_device_address<class_RenderingDevice_method_buffer_get_device_address>` on supported GPUs.
  1615. .. rst-class:: classref-item-separator
  1616. ----
  1617. .. _enum_RenderingDevice_UniformType:
  1618. .. rst-class:: classref-enumeration
  1619. enum **UniformType**: :ref:`๐Ÿ”—<enum_RenderingDevice_UniformType>`
  1620. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER:
  1621. .. rst-class:: classref-enumeration-constant
  1622. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_SAMPLER** = ``0``
  1623. Sampler uniform.
  1624. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE:
  1625. .. rst-class:: classref-enumeration-constant
  1626. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE** = ``1``
  1627. Sampler uniform with a texture.
  1628. .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE:
  1629. .. rst-class:: classref-enumeration-constant
  1630. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_TEXTURE** = ``2``
  1631. Texture uniform.
  1632. .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE:
  1633. .. rst-class:: classref-enumeration-constant
  1634. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_IMAGE** = ``3``
  1635. Image uniform.
  1636. .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE_BUFFER:
  1637. .. rst-class:: classref-enumeration-constant
  1638. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_TEXTURE_BUFFER** = ``4``
  1639. Texture buffer uniform.
  1640. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER:
  1641. .. rst-class:: classref-enumeration-constant
  1642. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER** = ``5``
  1643. Sampler uniform with a texture buffer.
  1644. .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE_BUFFER:
  1645. .. rst-class:: classref-enumeration-constant
  1646. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_IMAGE_BUFFER** = ``6``
  1647. Image buffer uniform.
  1648. .. _class_RenderingDevice_constant_UNIFORM_TYPE_UNIFORM_BUFFER:
  1649. .. rst-class:: classref-enumeration-constant
  1650. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_UNIFORM_BUFFER** = ``7``
  1651. Uniform buffer uniform.
  1652. .. _class_RenderingDevice_constant_UNIFORM_TYPE_STORAGE_BUFFER:
  1653. .. rst-class:: classref-enumeration-constant
  1654. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_STORAGE_BUFFER** = ``8``
  1655. `Storage buffer <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ uniform.
  1656. .. _class_RenderingDevice_constant_UNIFORM_TYPE_INPUT_ATTACHMENT:
  1657. .. rst-class:: classref-enumeration-constant
  1658. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_INPUT_ATTACHMENT** = ``9``
  1659. Input attachment uniform.
  1660. .. _class_RenderingDevice_constant_UNIFORM_TYPE_MAX:
  1661. .. rst-class:: classref-enumeration-constant
  1662. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_MAX** = ``10``
  1663. Represents the size of the :ref:`UniformType<enum_RenderingDevice_UniformType>` enum.
  1664. .. rst-class:: classref-item-separator
  1665. ----
  1666. .. _enum_RenderingDevice_RenderPrimitive:
  1667. .. rst-class:: classref-enumeration
  1668. enum **RenderPrimitive**: :ref:`๐Ÿ”—<enum_RenderingDevice_RenderPrimitive>`
  1669. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_POINTS:
  1670. .. rst-class:: classref-enumeration-constant
  1671. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_POINTS** = ``0``
  1672. Point rendering primitive (with constant size, regardless of distance from camera).
  1673. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES:
  1674. .. rst-class:: classref-enumeration-constant
  1675. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINES** = ``1``
  1676. Line list rendering primitive. Lines are drawn separated from each other.
  1677. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES_WITH_ADJACENCY:
  1678. .. rst-class:: classref-enumeration-constant
  1679. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINES_WITH_ADJACENCY** = ``2``
  1680. `Line list rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-line-lists-with-adjacency>`__\
  1681. \ **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1682. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS:
  1683. .. rst-class:: classref-enumeration-constant
  1684. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINESTRIPS** = ``3``
  1685. Line strip rendering primitive. Lines drawn are connected to the previous vertex.
  1686. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY:
  1687. .. rst-class:: classref-enumeration-constant
  1688. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY** = ``4``
  1689. `Line strip rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-line-strips-with-adjacency>`__\
  1690. \ **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1691. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES:
  1692. .. rst-class:: classref-enumeration-constant
  1693. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLES** = ``5``
  1694. Triangle list rendering primitive. Triangles are drawn separated from each other.
  1695. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY:
  1696. .. rst-class:: classref-enumeration-constant
  1697. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY** = ``6``
  1698. `Triangle list rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-triangle-lists-with-adjacency>`__\
  1699. **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1700. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS:
  1701. .. rst-class:: classref-enumeration-constant
  1702. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLE_STRIPS** = ``7``
  1703. Triangle strip rendering primitive. Triangles drawn are connected to the previous triangle.
  1704. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY:
  1705. .. rst-class:: classref-enumeration-constant
  1706. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY** = ``8``
  1707. `Triangle strip rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-triangle-strips-with-adjacency>`__\
  1708. \ **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1709. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX:
  1710. .. rst-class:: classref-enumeration-constant
  1711. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX** = ``9``
  1712. Triangle strip rendering primitive with *primitive restart* enabled. Triangles drawn are connected to the previous triangle, but a primitive restart index can be specified before drawing to create a second triangle strip after the specified index.
  1713. \ **Note:** Only compatible with indexed draws.
  1714. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TESSELATION_PATCH:
  1715. .. rst-class:: classref-enumeration-constant
  1716. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TESSELATION_PATCH** = ``10``
  1717. Tessellation patch rendering primitive. Only useful with tessellation shaders, which can be used to deform these patches.
  1718. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_MAX:
  1719. .. rst-class:: classref-enumeration-constant
  1720. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_MAX** = ``11``
  1721. Represents the size of the :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` enum.
  1722. .. rst-class:: classref-item-separator
  1723. ----
  1724. .. _enum_RenderingDevice_PolygonCullMode:
  1725. .. rst-class:: classref-enumeration
  1726. enum **PolygonCullMode**: :ref:`๐Ÿ”—<enum_RenderingDevice_PolygonCullMode>`
  1727. .. _class_RenderingDevice_constant_POLYGON_CULL_DISABLED:
  1728. .. rst-class:: classref-enumeration-constant
  1729. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **POLYGON_CULL_DISABLED** = ``0``
  1730. Do not use polygon front face or backface culling.
  1731. .. _class_RenderingDevice_constant_POLYGON_CULL_FRONT:
  1732. .. rst-class:: classref-enumeration-constant
  1733. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **POLYGON_CULL_FRONT** = ``1``
  1734. Use polygon frontface culling (faces pointing towards the camera are hidden).
  1735. .. _class_RenderingDevice_constant_POLYGON_CULL_BACK:
  1736. .. rst-class:: classref-enumeration-constant
  1737. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **POLYGON_CULL_BACK** = ``2``
  1738. Use polygon backface culling (faces pointing away from the camera are hidden).
  1739. .. rst-class:: classref-item-separator
  1740. ----
  1741. .. _enum_RenderingDevice_PolygonFrontFace:
  1742. .. rst-class:: classref-enumeration
  1743. enum **PolygonFrontFace**: :ref:`๐Ÿ”—<enum_RenderingDevice_PolygonFrontFace>`
  1744. .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_CLOCKWISE:
  1745. .. rst-class:: classref-enumeration-constant
  1746. :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` **POLYGON_FRONT_FACE_CLOCKWISE** = ``0``
  1747. Clockwise winding order to determine which face of a polygon is its front face.
  1748. .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_COUNTER_CLOCKWISE:
  1749. .. rst-class:: classref-enumeration-constant
  1750. :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` **POLYGON_FRONT_FACE_COUNTER_CLOCKWISE** = ``1``
  1751. Counter-clockwise winding order to determine which face of a polygon is its front face.
  1752. .. rst-class:: classref-item-separator
  1753. ----
  1754. .. _enum_RenderingDevice_StencilOperation:
  1755. .. rst-class:: classref-enumeration
  1756. enum **StencilOperation**: :ref:`๐Ÿ”—<enum_RenderingDevice_StencilOperation>`
  1757. .. _class_RenderingDevice_constant_STENCIL_OP_KEEP:
  1758. .. rst-class:: classref-enumeration-constant
  1759. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_KEEP** = ``0``
  1760. Keep the current stencil value.
  1761. .. _class_RenderingDevice_constant_STENCIL_OP_ZERO:
  1762. .. rst-class:: classref-enumeration-constant
  1763. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_ZERO** = ``1``
  1764. Set the stencil value to ``0``.
  1765. .. _class_RenderingDevice_constant_STENCIL_OP_REPLACE:
  1766. .. rst-class:: classref-enumeration-constant
  1767. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_REPLACE** = ``2``
  1768. Replace the existing stencil value with the new one.
  1769. .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_CLAMP:
  1770. .. rst-class:: classref-enumeration-constant
  1771. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_INCREMENT_AND_CLAMP** = ``3``
  1772. Increment the existing stencil value and clamp to the maximum representable unsigned value if reached. Stencil bits are considered as an unsigned integer.
  1773. .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_CLAMP:
  1774. .. rst-class:: classref-enumeration-constant
  1775. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_DECREMENT_AND_CLAMP** = ``4``
  1776. Decrement the existing stencil value and clamp to the minimum value if reached. Stencil bits are considered as an unsigned integer.
  1777. .. _class_RenderingDevice_constant_STENCIL_OP_INVERT:
  1778. .. rst-class:: classref-enumeration-constant
  1779. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_INVERT** = ``5``
  1780. Bitwise-invert the existing stencil value.
  1781. .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_WRAP:
  1782. .. rst-class:: classref-enumeration-constant
  1783. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_INCREMENT_AND_WRAP** = ``6``
  1784. Increment the stencil value and wrap around to ``0`` if reaching the maximum representable unsigned. Stencil bits are considered as an unsigned integer.
  1785. .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_WRAP:
  1786. .. rst-class:: classref-enumeration-constant
  1787. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_DECREMENT_AND_WRAP** = ``7``
  1788. Decrement the stencil value and wrap around to the maximum representable unsigned if reaching the minimum. Stencil bits are considered as an unsigned integer.
  1789. .. _class_RenderingDevice_constant_STENCIL_OP_MAX:
  1790. .. rst-class:: classref-enumeration-constant
  1791. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_MAX** = ``8``
  1792. Represents the size of the :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` enum.
  1793. .. rst-class:: classref-item-separator
  1794. ----
  1795. .. _enum_RenderingDevice_CompareOperator:
  1796. .. rst-class:: classref-enumeration
  1797. enum **CompareOperator**: :ref:`๐Ÿ”—<enum_RenderingDevice_CompareOperator>`
  1798. .. _class_RenderingDevice_constant_COMPARE_OP_NEVER:
  1799. .. rst-class:: classref-enumeration-constant
  1800. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_NEVER** = ``0``
  1801. "Never" comparison (opposite of :ref:`COMPARE_OP_ALWAYS<class_RenderingDevice_constant_COMPARE_OP_ALWAYS>`).
  1802. .. _class_RenderingDevice_constant_COMPARE_OP_LESS:
  1803. .. rst-class:: classref-enumeration-constant
  1804. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_LESS** = ``1``
  1805. "Less than" comparison.
  1806. .. _class_RenderingDevice_constant_COMPARE_OP_EQUAL:
  1807. .. rst-class:: classref-enumeration-constant
  1808. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_EQUAL** = ``2``
  1809. "Equal" comparison.
  1810. .. _class_RenderingDevice_constant_COMPARE_OP_LESS_OR_EQUAL:
  1811. .. rst-class:: classref-enumeration-constant
  1812. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_LESS_OR_EQUAL** = ``3``
  1813. "Less than or equal" comparison.
  1814. .. _class_RenderingDevice_constant_COMPARE_OP_GREATER:
  1815. .. rst-class:: classref-enumeration-constant
  1816. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_GREATER** = ``4``
  1817. "Greater than" comparison.
  1818. .. _class_RenderingDevice_constant_COMPARE_OP_NOT_EQUAL:
  1819. .. rst-class:: classref-enumeration-constant
  1820. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_NOT_EQUAL** = ``5``
  1821. "Not equal" comparison.
  1822. .. _class_RenderingDevice_constant_COMPARE_OP_GREATER_OR_EQUAL:
  1823. .. rst-class:: classref-enumeration-constant
  1824. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_GREATER_OR_EQUAL** = ``6``
  1825. "Greater than or equal" comparison.
  1826. .. _class_RenderingDevice_constant_COMPARE_OP_ALWAYS:
  1827. .. rst-class:: classref-enumeration-constant
  1828. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_ALWAYS** = ``7``
  1829. "Always" comparison (opposite of :ref:`COMPARE_OP_NEVER<class_RenderingDevice_constant_COMPARE_OP_NEVER>`).
  1830. .. _class_RenderingDevice_constant_COMPARE_OP_MAX:
  1831. .. rst-class:: classref-enumeration-constant
  1832. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_MAX** = ``8``
  1833. Represents the size of the :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` enum.
  1834. .. rst-class:: classref-item-separator
  1835. ----
  1836. .. _enum_RenderingDevice_LogicOperation:
  1837. .. rst-class:: classref-enumeration
  1838. enum **LogicOperation**: :ref:`๐Ÿ”—<enum_RenderingDevice_LogicOperation>`
  1839. .. _class_RenderingDevice_constant_LOGIC_OP_CLEAR:
  1840. .. rst-class:: classref-enumeration-constant
  1841. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_CLEAR** = ``0``
  1842. Clear logic operation (result is always ``0``). See also :ref:`LOGIC_OP_SET<class_RenderingDevice_constant_LOGIC_OP_SET>`.
  1843. .. _class_RenderingDevice_constant_LOGIC_OP_AND:
  1844. .. rst-class:: classref-enumeration-constant
  1845. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_AND** = ``1``
  1846. AND logic operation.
  1847. .. _class_RenderingDevice_constant_LOGIC_OP_AND_REVERSE:
  1848. .. rst-class:: classref-enumeration-constant
  1849. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_AND_REVERSE** = ``2``
  1850. AND logic operation with the *destination* operand being inverted. See also :ref:`LOGIC_OP_AND_INVERTED<class_RenderingDevice_constant_LOGIC_OP_AND_INVERTED>`.
  1851. .. _class_RenderingDevice_constant_LOGIC_OP_COPY:
  1852. .. rst-class:: classref-enumeration-constant
  1853. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_COPY** = ``3``
  1854. Copy logic operation (keeps the *source* value as-is). See also :ref:`LOGIC_OP_COPY_INVERTED<class_RenderingDevice_constant_LOGIC_OP_COPY_INVERTED>` and :ref:`LOGIC_OP_NO_OP<class_RenderingDevice_constant_LOGIC_OP_NO_OP>`.
  1855. .. _class_RenderingDevice_constant_LOGIC_OP_AND_INVERTED:
  1856. .. rst-class:: classref-enumeration-constant
  1857. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_AND_INVERTED** = ``4``
  1858. AND logic operation with the *source* operand being inverted. See also :ref:`LOGIC_OP_AND_REVERSE<class_RenderingDevice_constant_LOGIC_OP_AND_REVERSE>`.
  1859. .. _class_RenderingDevice_constant_LOGIC_OP_NO_OP:
  1860. .. rst-class:: classref-enumeration-constant
  1861. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_NO_OP** = ``5``
  1862. No-op logic operation (keeps the *destination* value as-is). See also :ref:`LOGIC_OP_COPY<class_RenderingDevice_constant_LOGIC_OP_COPY>`.
  1863. .. _class_RenderingDevice_constant_LOGIC_OP_XOR:
  1864. .. rst-class:: classref-enumeration-constant
  1865. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_XOR** = ``6``
  1866. Exclusive or (XOR) logic operation.
  1867. .. _class_RenderingDevice_constant_LOGIC_OP_OR:
  1868. .. rst-class:: classref-enumeration-constant
  1869. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_OR** = ``7``
  1870. OR logic operation.
  1871. .. _class_RenderingDevice_constant_LOGIC_OP_NOR:
  1872. .. rst-class:: classref-enumeration-constant
  1873. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_NOR** = ``8``
  1874. Not-OR (NOR) logic operation.
  1875. .. _class_RenderingDevice_constant_LOGIC_OP_EQUIVALENT:
  1876. .. rst-class:: classref-enumeration-constant
  1877. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_EQUIVALENT** = ``9``
  1878. Not-XOR (XNOR) logic operation.
  1879. .. _class_RenderingDevice_constant_LOGIC_OP_INVERT:
  1880. .. rst-class:: classref-enumeration-constant
  1881. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_INVERT** = ``10``
  1882. Invert logic operation.
  1883. .. _class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE:
  1884. .. rst-class:: classref-enumeration-constant
  1885. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_OR_REVERSE** = ``11``
  1886. OR logic operation with the *destination* operand being inverted. See also :ref:`LOGIC_OP_OR_REVERSE<class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE>`.
  1887. .. _class_RenderingDevice_constant_LOGIC_OP_COPY_INVERTED:
  1888. .. rst-class:: classref-enumeration-constant
  1889. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_COPY_INVERTED** = ``12``
  1890. NOT logic operation (inverts the value). See also :ref:`LOGIC_OP_COPY<class_RenderingDevice_constant_LOGIC_OP_COPY>`.
  1891. .. _class_RenderingDevice_constant_LOGIC_OP_OR_INVERTED:
  1892. .. rst-class:: classref-enumeration-constant
  1893. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_OR_INVERTED** = ``13``
  1894. OR logic operation with the *source* operand being inverted. See also :ref:`LOGIC_OP_OR_REVERSE<class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE>`.
  1895. .. _class_RenderingDevice_constant_LOGIC_OP_NAND:
  1896. .. rst-class:: classref-enumeration-constant
  1897. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_NAND** = ``14``
  1898. Not-AND (NAND) logic operation.
  1899. .. _class_RenderingDevice_constant_LOGIC_OP_SET:
  1900. .. rst-class:: classref-enumeration-constant
  1901. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_SET** = ``15``
  1902. SET logic operation (result is always ``1``). See also :ref:`LOGIC_OP_CLEAR<class_RenderingDevice_constant_LOGIC_OP_CLEAR>`.
  1903. .. _class_RenderingDevice_constant_LOGIC_OP_MAX:
  1904. .. rst-class:: classref-enumeration-constant
  1905. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_MAX** = ``16``
  1906. Represents the size of the :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` enum.
  1907. .. rst-class:: classref-item-separator
  1908. ----
  1909. .. _enum_RenderingDevice_BlendFactor:
  1910. .. rst-class:: classref-enumeration
  1911. enum **BlendFactor**: :ref:`๐Ÿ”—<enum_RenderingDevice_BlendFactor>`
  1912. .. _class_RenderingDevice_constant_BLEND_FACTOR_ZERO:
  1913. .. rst-class:: classref-enumeration-constant
  1914. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ZERO** = ``0``
  1915. Constant ``0.0`` blend factor.
  1916. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE:
  1917. .. rst-class:: classref-enumeration-constant
  1918. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE** = ``1``
  1919. Constant ``1.0`` blend factor.
  1920. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_COLOR:
  1921. .. rst-class:: classref-enumeration-constant
  1922. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC_COLOR** = ``2``
  1923. Color blend factor is ``source color``. Alpha blend factor is ``source alpha``.
  1924. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_COLOR:
  1925. .. rst-class:: classref-enumeration-constant
  1926. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC_COLOR** = ``3``
  1927. Color blend factor is ``1.0 - source color``. Alpha blend factor is ``1.0 - source alpha``.
  1928. .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_COLOR:
  1929. .. rst-class:: classref-enumeration-constant
  1930. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_DST_COLOR** = ``4``
  1931. Color blend factor is ``destination color``. Alpha blend factor is ``destination alpha``.
  1932. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_COLOR:
  1933. .. rst-class:: classref-enumeration-constant
  1934. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_DST_COLOR** = ``5``
  1935. Color blend factor is ``1.0 - destination color``. Alpha blend factor is ``1.0 - destination alpha``.
  1936. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA:
  1937. .. rst-class:: classref-enumeration-constant
  1938. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC_ALPHA** = ``6``
  1939. Color and alpha blend factor is ``source alpha``.
  1940. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA:
  1941. .. rst-class:: classref-enumeration-constant
  1942. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC_ALPHA** = ``7``
  1943. Color and alpha blend factor is ``1.0 - source alpha``.
  1944. .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_ALPHA:
  1945. .. rst-class:: classref-enumeration-constant
  1946. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_DST_ALPHA** = ``8``
  1947. Color and alpha blend factor is ``destination alpha``.
  1948. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_ALPHA:
  1949. .. rst-class:: classref-enumeration-constant
  1950. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_DST_ALPHA** = ``9``
  1951. Color and alpha blend factor is ``1.0 - destination alpha``.
  1952. .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_COLOR:
  1953. .. rst-class:: classref-enumeration-constant
  1954. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_CONSTANT_COLOR** = ``10``
  1955. Color blend factor is ``blend constant color``. Alpha blend factor is ``blend constant alpha`` (see :ref:`draw_list_set_blend_constants<class_RenderingDevice_method_draw_list_set_blend_constants>`).
  1956. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR:
  1957. .. rst-class:: classref-enumeration-constant
  1958. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR** = ``11``
  1959. Color blend factor is ``1.0 - blend constant color``. Alpha blend factor is ``1.0 - blend constant alpha`` (see :ref:`draw_list_set_blend_constants<class_RenderingDevice_method_draw_list_set_blend_constants>`).
  1960. .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_ALPHA:
  1961. .. rst-class:: classref-enumeration-constant
  1962. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_CONSTANT_ALPHA** = ``12``
  1963. Color and alpha blend factor is ``blend constant alpha`` (see :ref:`draw_list_set_blend_constants<class_RenderingDevice_method_draw_list_set_blend_constants>`).
  1964. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA:
  1965. .. rst-class:: classref-enumeration-constant
  1966. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA** = ``13``
  1967. Color and alpha blend factor is ``1.0 - blend constant alpha`` (see :ref:`draw_list_set_blend_constants<class_RenderingDevice_method_draw_list_set_blend_constants>`).
  1968. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA_SATURATE:
  1969. .. rst-class:: classref-enumeration-constant
  1970. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC_ALPHA_SATURATE** = ``14``
  1971. Color blend factor is ``min(source alpha, 1.0 - destination alpha)``. Alpha blend factor is ``1.0``.
  1972. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_COLOR:
  1973. .. rst-class:: classref-enumeration-constant
  1974. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC1_COLOR** = ``15``
  1975. Color blend factor is ``second source color``. Alpha blend factor is ``second source alpha``. Only relevant for dual-source blending.
  1976. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR:
  1977. .. rst-class:: classref-enumeration-constant
  1978. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC1_COLOR** = ``16``
  1979. Color blend factor is ``1.0 - second source color``. Alpha blend factor is ``1.0 - second source alpha``. Only relevant for dual-source blending.
  1980. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_ALPHA:
  1981. .. rst-class:: classref-enumeration-constant
  1982. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC1_ALPHA** = ``17``
  1983. Color and alpha blend factor is ``second source alpha``. Only relevant for dual-source blending.
  1984. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA:
  1985. .. rst-class:: classref-enumeration-constant
  1986. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA** = ``18``
  1987. Color and alpha blend factor is ``1.0 - second source alpha``. Only relevant for dual-source blending.
  1988. .. _class_RenderingDevice_constant_BLEND_FACTOR_MAX:
  1989. .. rst-class:: classref-enumeration-constant
  1990. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_MAX** = ``19``
  1991. Represents the size of the :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` enum.
  1992. .. rst-class:: classref-item-separator
  1993. ----
  1994. .. _enum_RenderingDevice_BlendOperation:
  1995. .. rst-class:: classref-enumeration
  1996. enum **BlendOperation**: :ref:`๐Ÿ”—<enum_RenderingDevice_BlendOperation>`
  1997. .. _class_RenderingDevice_constant_BLEND_OP_ADD:
  1998. .. rst-class:: classref-enumeration-constant
  1999. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_ADD** = ``0``
  2000. Additive blending operation (``source + destination``).
  2001. .. _class_RenderingDevice_constant_BLEND_OP_SUBTRACT:
  2002. .. rst-class:: classref-enumeration-constant
  2003. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_SUBTRACT** = ``1``
  2004. Subtractive blending operation (``source - destination``).
  2005. .. _class_RenderingDevice_constant_BLEND_OP_REVERSE_SUBTRACT:
  2006. .. rst-class:: classref-enumeration-constant
  2007. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_REVERSE_SUBTRACT** = ``2``
  2008. Reverse subtractive blending operation (``destination - source``).
  2009. .. _class_RenderingDevice_constant_BLEND_OP_MINIMUM:
  2010. .. rst-class:: classref-enumeration-constant
  2011. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_MINIMUM** = ``3``
  2012. Minimum blending operation (keep the lowest value of the two).
  2013. .. _class_RenderingDevice_constant_BLEND_OP_MAXIMUM:
  2014. .. rst-class:: classref-enumeration-constant
  2015. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_MAXIMUM** = ``4``
  2016. Maximum blending operation (keep the highest value of the two).
  2017. .. _class_RenderingDevice_constant_BLEND_OP_MAX:
  2018. .. rst-class:: classref-enumeration-constant
  2019. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_MAX** = ``5``
  2020. Represents the size of the :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` enum.
  2021. .. rst-class:: classref-item-separator
  2022. ----
  2023. .. _enum_RenderingDevice_PipelineDynamicStateFlags:
  2024. .. rst-class:: classref-enumeration
  2025. flags **PipelineDynamicStateFlags**: :ref:`๐Ÿ”—<enum_RenderingDevice_PipelineDynamicStateFlags>`
  2026. .. _class_RenderingDevice_constant_DYNAMIC_STATE_LINE_WIDTH:
  2027. .. rst-class:: classref-enumeration-constant
  2028. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_LINE_WIDTH** = ``1``
  2029. Allows dynamically changing the width of rendering lines.
  2030. .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BIAS:
  2031. .. rst-class:: classref-enumeration-constant
  2032. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_DEPTH_BIAS** = ``2``
  2033. Allows dynamically changing the depth bias.
  2034. .. _class_RenderingDevice_constant_DYNAMIC_STATE_BLEND_CONSTANTS:
  2035. .. rst-class:: classref-enumeration-constant
  2036. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_BLEND_CONSTANTS** = ``4``
  2037. .. container:: contribute
  2038. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2039. .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BOUNDS:
  2040. .. rst-class:: classref-enumeration-constant
  2041. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_DEPTH_BOUNDS** = ``8``
  2042. .. container:: contribute
  2043. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2044. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_COMPARE_MASK:
  2045. .. rst-class:: classref-enumeration-constant
  2046. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_STENCIL_COMPARE_MASK** = ``16``
  2047. .. container:: contribute
  2048. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2049. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_WRITE_MASK:
  2050. .. rst-class:: classref-enumeration-constant
  2051. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_STENCIL_WRITE_MASK** = ``32``
  2052. .. container:: contribute
  2053. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2054. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_REFERENCE:
  2055. .. rst-class:: classref-enumeration-constant
  2056. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_STENCIL_REFERENCE** = ``64``
  2057. .. container:: contribute
  2058. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2059. .. rst-class:: classref-item-separator
  2060. ----
  2061. .. _enum_RenderingDevice_InitialAction:
  2062. .. rst-class:: classref-enumeration
  2063. enum **InitialAction**: :ref:`๐Ÿ”—<enum_RenderingDevice_InitialAction>`
  2064. .. _class_RenderingDevice_constant_INITIAL_ACTION_LOAD:
  2065. .. rst-class:: classref-enumeration-constant
  2066. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_LOAD** = ``0``
  2067. **Deprecated:** Initial actions are solved automatically by RenderingDevice.
  2068. Load the previous contents of the framebuffer.
  2069. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR:
  2070. .. rst-class:: classref-enumeration-constant
  2071. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CLEAR** = ``1``
  2072. **Deprecated:** Initial actions are solved automatically by RenderingDevice.
  2073. Clear the whole framebuffer or its specified region.
  2074. .. _class_RenderingDevice_constant_INITIAL_ACTION_DISCARD:
  2075. .. rst-class:: classref-enumeration-constant
  2076. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_DISCARD** = ``2``
  2077. **Deprecated:** Initial actions are solved automatically by RenderingDevice.
  2078. Ignore the previous contents of the framebuffer. This is the fastest option if you'll overwrite all of the pixels and don't need to read any of them.
  2079. .. _class_RenderingDevice_constant_INITIAL_ACTION_MAX:
  2080. .. rst-class:: classref-enumeration-constant
  2081. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_MAX** = ``3``
  2082. **Deprecated:** Initial actions are solved automatically by RenderingDevice.
  2083. Represents the size of the :ref:`InitialAction<enum_RenderingDevice_InitialAction>` enum.
  2084. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION:
  2085. .. rst-class:: classref-enumeration-constant
  2086. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CLEAR_REGION** = ``1``
  2087. **Deprecated:** Initial actions are solved automatically by RenderingDevice.
  2088. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION_CONTINUE:
  2089. .. rst-class:: classref-enumeration-constant
  2090. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CLEAR_REGION_CONTINUE** = ``1``
  2091. **Deprecated:** Initial actions are solved automatically by RenderingDevice.
  2092. .. _class_RenderingDevice_constant_INITIAL_ACTION_KEEP:
  2093. .. rst-class:: classref-enumeration-constant
  2094. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_KEEP** = ``0``
  2095. **Deprecated:** Initial actions are solved automatically by RenderingDevice.
  2096. .. _class_RenderingDevice_constant_INITIAL_ACTION_DROP:
  2097. .. rst-class:: classref-enumeration-constant
  2098. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_DROP** = ``2``
  2099. **Deprecated:** Initial actions are solved automatically by RenderingDevice.
  2100. .. _class_RenderingDevice_constant_INITIAL_ACTION_CONTINUE:
  2101. .. rst-class:: classref-enumeration-constant
  2102. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CONTINUE** = ``0``
  2103. **Deprecated:** Initial actions are solved automatically by RenderingDevice.
  2104. .. rst-class:: classref-item-separator
  2105. ----
  2106. .. _enum_RenderingDevice_FinalAction:
  2107. .. rst-class:: classref-enumeration
  2108. enum **FinalAction**: :ref:`๐Ÿ”—<enum_RenderingDevice_FinalAction>`
  2109. .. _class_RenderingDevice_constant_FINAL_ACTION_STORE:
  2110. .. rst-class:: classref-enumeration-constant
  2111. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_STORE** = ``0``
  2112. **Deprecated:** Final actions are solved automatically by RenderingDevice.
  2113. Store the result of the draw list in the framebuffer. This is generally what you want to do.
  2114. .. _class_RenderingDevice_constant_FINAL_ACTION_DISCARD:
  2115. .. rst-class:: classref-enumeration-constant
  2116. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_DISCARD** = ``1``
  2117. **Deprecated:** Final actions are solved automatically by RenderingDevice.
  2118. Discard the contents of the framebuffer. This is the fastest option if you don't need to use the results of the draw list.
  2119. .. _class_RenderingDevice_constant_FINAL_ACTION_MAX:
  2120. .. rst-class:: classref-enumeration-constant
  2121. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_MAX** = ``2``
  2122. **Deprecated:** Final actions are solved automatically by RenderingDevice.
  2123. Represents the size of the :ref:`FinalAction<enum_RenderingDevice_FinalAction>` enum.
  2124. .. _class_RenderingDevice_constant_FINAL_ACTION_READ:
  2125. .. rst-class:: classref-enumeration-constant
  2126. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_READ** = ``0``
  2127. **Deprecated:** Final actions are solved automatically by RenderingDevice.
  2128. .. _class_RenderingDevice_constant_FINAL_ACTION_CONTINUE:
  2129. .. rst-class:: classref-enumeration-constant
  2130. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_CONTINUE** = ``0``
  2131. **Deprecated:** Final actions are solved automatically by RenderingDevice.
  2132. .. rst-class:: classref-item-separator
  2133. ----
  2134. .. _enum_RenderingDevice_ShaderStage:
  2135. .. rst-class:: classref-enumeration
  2136. enum **ShaderStage**: :ref:`๐Ÿ”—<enum_RenderingDevice_ShaderStage>`
  2137. .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX:
  2138. .. rst-class:: classref-enumeration-constant
  2139. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_VERTEX** = ``0``
  2140. Vertex shader stage. This can be used to manipulate vertices from a shader (but not create new vertices).
  2141. .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT:
  2142. .. rst-class:: classref-enumeration-constant
  2143. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_FRAGMENT** = ``1``
  2144. Fragment shader stage (called "pixel shader" in Direct3D). This can be used to manipulate pixels from a shader.
  2145. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL:
  2146. .. rst-class:: classref-enumeration-constant
  2147. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_CONTROL** = ``2``
  2148. Tessellation control shader stage. This can be used to create additional geometry from a shader.
  2149. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION:
  2150. .. rst-class:: classref-enumeration-constant
  2151. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_EVALUATION** = ``3``
  2152. Tessellation evaluation shader stage. This can be used to create additional geometry from a shader.
  2153. .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE:
  2154. .. rst-class:: classref-enumeration-constant
  2155. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_COMPUTE** = ``4``
  2156. Compute shader stage. This can be used to run arbitrary computing tasks in a shader, performing them on the GPU instead of the CPU.
  2157. .. _class_RenderingDevice_constant_SHADER_STAGE_MAX:
  2158. .. rst-class:: classref-enumeration-constant
  2159. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_MAX** = ``5``
  2160. Represents the size of the :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` enum.
  2161. .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX_BIT:
  2162. .. rst-class:: classref-enumeration-constant
  2163. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_VERTEX_BIT** = ``1``
  2164. Vertex shader stage bit (see also :ref:`SHADER_STAGE_VERTEX<class_RenderingDevice_constant_SHADER_STAGE_VERTEX>`).
  2165. .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT_BIT:
  2166. .. rst-class:: classref-enumeration-constant
  2167. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_FRAGMENT_BIT** = ``2``
  2168. Fragment shader stage bit (see also :ref:`SHADER_STAGE_FRAGMENT<class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT>`).
  2169. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL_BIT:
  2170. .. rst-class:: classref-enumeration-constant
  2171. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_CONTROL_BIT** = ``4``
  2172. Tessellation control shader stage bit (see also :ref:`SHADER_STAGE_TESSELATION_CONTROL<class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL>`).
  2173. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION_BIT:
  2174. .. rst-class:: classref-enumeration-constant
  2175. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_EVALUATION_BIT** = ``8``
  2176. Tessellation evaluation shader stage bit (see also :ref:`SHADER_STAGE_TESSELATION_EVALUATION<class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION>`).
  2177. .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE_BIT:
  2178. .. rst-class:: classref-enumeration-constant
  2179. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_COMPUTE_BIT** = ``16``
  2180. Compute shader stage bit (see also :ref:`SHADER_STAGE_COMPUTE<class_RenderingDevice_constant_SHADER_STAGE_COMPUTE>`).
  2181. .. rst-class:: classref-item-separator
  2182. ----
  2183. .. _enum_RenderingDevice_ShaderLanguage:
  2184. .. rst-class:: classref-enumeration
  2185. enum **ShaderLanguage**: :ref:`๐Ÿ”—<enum_RenderingDevice_ShaderLanguage>`
  2186. .. _class_RenderingDevice_constant_SHADER_LANGUAGE_GLSL:
  2187. .. rst-class:: classref-enumeration-constant
  2188. :ref:`ShaderLanguage<enum_RenderingDevice_ShaderLanguage>` **SHADER_LANGUAGE_GLSL** = ``0``
  2189. Khronos' GLSL shading language (used natively by OpenGL and Vulkan). This is the language used for core Godot shaders.
  2190. .. _class_RenderingDevice_constant_SHADER_LANGUAGE_HLSL:
  2191. .. rst-class:: classref-enumeration-constant
  2192. :ref:`ShaderLanguage<enum_RenderingDevice_ShaderLanguage>` **SHADER_LANGUAGE_HLSL** = ``1``
  2193. Microsoft's High-Level Shading Language (used natively by Direct3D, but can also be used in Vulkan).
  2194. .. rst-class:: classref-item-separator
  2195. ----
  2196. .. _enum_RenderingDevice_PipelineSpecializationConstantType:
  2197. .. rst-class:: classref-enumeration
  2198. enum **PipelineSpecializationConstantType**: :ref:`๐Ÿ”—<enum_RenderingDevice_PipelineSpecializationConstantType>`
  2199. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL:
  2200. .. rst-class:: classref-enumeration-constant
  2201. :ref:`PipelineSpecializationConstantType<enum_RenderingDevice_PipelineSpecializationConstantType>` **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL** = ``0``
  2202. Boolean specialization constant.
  2203. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT:
  2204. .. rst-class:: classref-enumeration-constant
  2205. :ref:`PipelineSpecializationConstantType<enum_RenderingDevice_PipelineSpecializationConstantType>` **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT** = ``1``
  2206. Integer specialization constant.
  2207. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT:
  2208. .. rst-class:: classref-enumeration-constant
  2209. :ref:`PipelineSpecializationConstantType<enum_RenderingDevice_PipelineSpecializationConstantType>` **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT** = ``2``
  2210. Floating-point specialization constant.
  2211. .. rst-class:: classref-item-separator
  2212. ----
  2213. .. _enum_RenderingDevice_Features:
  2214. .. rst-class:: classref-enumeration
  2215. enum **Features**: :ref:`๐Ÿ”—<enum_RenderingDevice_Features>`
  2216. .. _class_RenderingDevice_constant_SUPPORTS_BUFFER_DEVICE_ADDRESS:
  2217. .. rst-class:: classref-enumeration-constant
  2218. :ref:`Features<enum_RenderingDevice_Features>` **SUPPORTS_BUFFER_DEVICE_ADDRESS** = ``6``
  2219. Features support for buffer device address extension.
  2220. .. rst-class:: classref-item-separator
  2221. ----
  2222. .. _enum_RenderingDevice_Limit:
  2223. .. rst-class:: classref-enumeration
  2224. enum **Limit**: :ref:`๐Ÿ”—<enum_RenderingDevice_Limit>`
  2225. .. _class_RenderingDevice_constant_LIMIT_MAX_BOUND_UNIFORM_SETS:
  2226. .. rst-class:: classref-enumeration-constant
  2227. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_BOUND_UNIFORM_SETS** = ``0``
  2228. Maximum number of uniform sets that can be bound at a given time.
  2229. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS:
  2230. .. rst-class:: classref-enumeration-constant
  2231. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS** = ``1``
  2232. Maximum number of color framebuffer attachments that can be used at a given time.
  2233. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_UNIFORM_SET:
  2234. .. rst-class:: classref-enumeration-constant
  2235. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURES_PER_UNIFORM_SET** = ``2``
  2236. Maximum number of textures that can be used per uniform set.
  2237. .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET:
  2238. .. rst-class:: classref-enumeration-constant
  2239. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET** = ``3``
  2240. Maximum number of samplers that can be used per uniform set.
  2241. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET:
  2242. .. rst-class:: classref-enumeration-constant
  2243. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET** = ``4``
  2244. Maximum number of `storage buffers <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ per uniform set.
  2245. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET:
  2246. .. rst-class:: classref-enumeration-constant
  2247. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET** = ``5``
  2248. Maximum number of storage images per uniform set.
  2249. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET:
  2250. .. rst-class:: classref-enumeration-constant
  2251. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET** = ``6``
  2252. Maximum number of uniform buffers per uniform set.
  2253. .. _class_RenderingDevice_constant_LIMIT_MAX_DRAW_INDEXED_INDEX:
  2254. .. rst-class:: classref-enumeration-constant
  2255. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_DRAW_INDEXED_INDEX** = ``7``
  2256. Maximum index for an indexed draw command.
  2257. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_HEIGHT:
  2258. .. rst-class:: classref-enumeration-constant
  2259. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_FRAMEBUFFER_HEIGHT** = ``8``
  2260. Maximum height of a framebuffer (in pixels).
  2261. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_WIDTH:
  2262. .. rst-class:: classref-enumeration-constant
  2263. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_FRAMEBUFFER_WIDTH** = ``9``
  2264. Maximum width of a framebuffer (in pixels).
  2265. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_ARRAY_LAYERS:
  2266. .. rst-class:: classref-enumeration-constant
  2267. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_ARRAY_LAYERS** = ``10``
  2268. Maximum number of texture array layers.
  2269. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_1D:
  2270. .. rst-class:: classref-enumeration-constant
  2271. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_1D** = ``11``
  2272. Maximum supported 1-dimensional texture size (in pixels on a single axis).
  2273. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_2D:
  2274. .. rst-class:: classref-enumeration-constant
  2275. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_2D** = ``12``
  2276. Maximum supported 2-dimensional texture size (in pixels on a single axis).
  2277. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_3D:
  2278. .. rst-class:: classref-enumeration-constant
  2279. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_3D** = ``13``
  2280. Maximum supported 3-dimensional texture size (in pixels on a single axis).
  2281. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_CUBE:
  2282. .. rst-class:: classref-enumeration-constant
  2283. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_CUBE** = ``14``
  2284. Maximum supported cubemap texture size (in pixels on a single axis of a single face).
  2285. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_SHADER_STAGE:
  2286. .. rst-class:: classref-enumeration-constant
  2287. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURES_PER_SHADER_STAGE** = ``15``
  2288. Maximum number of textures per shader stage.
  2289. .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE:
  2290. .. rst-class:: classref-enumeration-constant
  2291. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE** = ``16``
  2292. Maximum number of samplers per shader stage.
  2293. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE:
  2294. .. rst-class:: classref-enumeration-constant
  2295. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE** = ``17``
  2296. Maximum number of `storage buffers <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ per shader stage.
  2297. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE:
  2298. .. rst-class:: classref-enumeration-constant
  2299. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE** = ``18``
  2300. Maximum number of storage images per shader stage.
  2301. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE:
  2302. .. rst-class:: classref-enumeration-constant
  2303. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE** = ``19``
  2304. Maximum number of uniform buffers per uniform set.
  2305. .. _class_RenderingDevice_constant_LIMIT_MAX_PUSH_CONSTANT_SIZE:
  2306. .. rst-class:: classref-enumeration-constant
  2307. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_PUSH_CONSTANT_SIZE** = ``20``
  2308. Maximum size of a push constant. A lot of devices are limited to 128 bytes, so try to avoid exceeding 128 bytes in push constants to ensure compatibility even if your GPU is reporting a higher value.
  2309. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFER_SIZE:
  2310. .. rst-class:: classref-enumeration-constant
  2311. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_UNIFORM_BUFFER_SIZE** = ``21``
  2312. Maximum size of a uniform buffer.
  2313. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET:
  2314. .. rst-class:: classref-enumeration-constant
  2315. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET** = ``22``
  2316. Maximum vertex input attribute offset.
  2317. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES:
  2318. .. rst-class:: classref-enumeration-constant
  2319. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES** = ``23``
  2320. Maximum number of vertex input attributes.
  2321. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDINGS:
  2322. .. rst-class:: classref-enumeration-constant
  2323. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_BINDINGS** = ``24``
  2324. Maximum number of vertex input bindings.
  2325. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE:
  2326. .. rst-class:: classref-enumeration-constant
  2327. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE** = ``25``
  2328. Maximum vertex input binding stride.
  2329. .. _class_RenderingDevice_constant_LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT:
  2330. .. rst-class:: classref-enumeration-constant
  2331. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT** = ``26``
  2332. Minimum uniform buffer offset alignment.
  2333. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE:
  2334. .. rst-class:: classref-enumeration-constant
  2335. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE** = ``27``
  2336. Maximum shared memory size for compute shaders.
  2337. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X:
  2338. .. rst-class:: classref-enumeration-constant
  2339. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X** = ``28``
  2340. Maximum number of workgroups for compute shaders on the X axis.
  2341. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y:
  2342. .. rst-class:: classref-enumeration-constant
  2343. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y** = ``29``
  2344. Maximum number of workgroups for compute shaders on the Y axis.
  2345. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z:
  2346. .. rst-class:: classref-enumeration-constant
  2347. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z** = ``30``
  2348. Maximum number of workgroups for compute shaders on the Z axis.
  2349. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS:
  2350. .. rst-class:: classref-enumeration-constant
  2351. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS** = ``31``
  2352. Maximum number of workgroup invocations for compute shaders.
  2353. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X:
  2354. .. rst-class:: classref-enumeration-constant
  2355. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X** = ``32``
  2356. Maximum workgroup size for compute shaders on the X axis.
  2357. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y:
  2358. .. rst-class:: classref-enumeration-constant
  2359. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y** = ``33``
  2360. Maximum workgroup size for compute shaders on the Y axis.
  2361. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z:
  2362. .. rst-class:: classref-enumeration-constant
  2363. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z** = ``34``
  2364. Maximum workgroup size for compute shaders on the Z axis.
  2365. .. _class_RenderingDevice_constant_LIMIT_MAX_VIEWPORT_DIMENSIONS_X:
  2366. .. rst-class:: classref-enumeration-constant
  2367. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VIEWPORT_DIMENSIONS_X** = ``35``
  2368. Maximum viewport width (in pixels).
  2369. .. _class_RenderingDevice_constant_LIMIT_MAX_VIEWPORT_DIMENSIONS_Y:
  2370. .. rst-class:: classref-enumeration-constant
  2371. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VIEWPORT_DIMENSIONS_Y** = ``36``
  2372. Maximum viewport height (in pixels).
  2373. .. _class_RenderingDevice_constant_LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE:
  2374. .. rst-class:: classref-enumeration-constant
  2375. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_METALFX_TEMPORAL_SCALER_MIN_SCALE** = ``46``
  2376. Returns the smallest value for :ref:`ProjectSettings.rendering/scaling_3d/scale<class_ProjectSettings_property_rendering/scaling_3d/scale>` when using the MetalFX temporal upscaler.
  2377. \ **Note:** The returned value is multiplied by a factor of ``1000000`` to preserve 6 digits of precision. It must be divided by ``1000000.0`` to convert the value to a floating point number.
  2378. .. _class_RenderingDevice_constant_LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE:
  2379. .. rst-class:: classref-enumeration-constant
  2380. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_METALFX_TEMPORAL_SCALER_MAX_SCALE** = ``47``
  2381. Returns the largest value for :ref:`ProjectSettings.rendering/scaling_3d/scale<class_ProjectSettings_property_rendering/scaling_3d/scale>` when using the MetalFX temporal upscaler.
  2382. \ **Note:** The returned value is multiplied by a factor of ``1000000`` to preserve 6 digits of precision. It must be divided by ``1000000.0`` to convert the value to a floating point number.
  2383. .. rst-class:: classref-item-separator
  2384. ----
  2385. .. _enum_RenderingDevice_MemoryType:
  2386. .. rst-class:: classref-enumeration
  2387. enum **MemoryType**: :ref:`๐Ÿ”—<enum_RenderingDevice_MemoryType>`
  2388. .. _class_RenderingDevice_constant_MEMORY_TEXTURES:
  2389. .. rst-class:: classref-enumeration-constant
  2390. :ref:`MemoryType<enum_RenderingDevice_MemoryType>` **MEMORY_TEXTURES** = ``0``
  2391. Memory taken by textures.
  2392. .. _class_RenderingDevice_constant_MEMORY_BUFFERS:
  2393. .. rst-class:: classref-enumeration-constant
  2394. :ref:`MemoryType<enum_RenderingDevice_MemoryType>` **MEMORY_BUFFERS** = ``1``
  2395. Memory taken by buffers.
  2396. .. _class_RenderingDevice_constant_MEMORY_TOTAL:
  2397. .. rst-class:: classref-enumeration-constant
  2398. :ref:`MemoryType<enum_RenderingDevice_MemoryType>` **MEMORY_TOTAL** = ``2``
  2399. Total memory taken. This is greater than the sum of :ref:`MEMORY_TEXTURES<class_RenderingDevice_constant_MEMORY_TEXTURES>` and :ref:`MEMORY_BUFFERS<class_RenderingDevice_constant_MEMORY_BUFFERS>`, as it also includes miscellaneous memory usage.
  2400. .. rst-class:: classref-item-separator
  2401. ----
  2402. .. _enum_RenderingDevice_BreadcrumbMarker:
  2403. .. rst-class:: classref-enumeration
  2404. enum **BreadcrumbMarker**: :ref:`๐Ÿ”—<enum_RenderingDevice_BreadcrumbMarker>`
  2405. .. _class_RenderingDevice_constant_NONE:
  2406. .. rst-class:: classref-enumeration-constant
  2407. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **NONE** = ``0``
  2408. .. container:: contribute
  2409. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2410. .. _class_RenderingDevice_constant_REFLECTION_PROBES:
  2411. .. rst-class:: classref-enumeration-constant
  2412. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **REFLECTION_PROBES** = ``65536``
  2413. .. container:: contribute
  2414. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2415. .. _class_RenderingDevice_constant_SKY_PASS:
  2416. .. rst-class:: classref-enumeration-constant
  2417. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **SKY_PASS** = ``131072``
  2418. .. container:: contribute
  2419. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2420. .. _class_RenderingDevice_constant_LIGHTMAPPER_PASS:
  2421. .. rst-class:: classref-enumeration-constant
  2422. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **LIGHTMAPPER_PASS** = ``196608``
  2423. .. container:: contribute
  2424. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2425. .. _class_RenderingDevice_constant_SHADOW_PASS_DIRECTIONAL:
  2426. .. rst-class:: classref-enumeration-constant
  2427. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **SHADOW_PASS_DIRECTIONAL** = ``262144``
  2428. .. container:: contribute
  2429. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2430. .. _class_RenderingDevice_constant_SHADOW_PASS_CUBE:
  2431. .. rst-class:: classref-enumeration-constant
  2432. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **SHADOW_PASS_CUBE** = ``327680``
  2433. .. container:: contribute
  2434. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2435. .. _class_RenderingDevice_constant_OPAQUE_PASS:
  2436. .. rst-class:: classref-enumeration-constant
  2437. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **OPAQUE_PASS** = ``393216``
  2438. .. container:: contribute
  2439. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2440. .. _class_RenderingDevice_constant_ALPHA_PASS:
  2441. .. rst-class:: classref-enumeration-constant
  2442. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **ALPHA_PASS** = ``458752``
  2443. .. container:: contribute
  2444. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2445. .. _class_RenderingDevice_constant_TRANSPARENT_PASS:
  2446. .. rst-class:: classref-enumeration-constant
  2447. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **TRANSPARENT_PASS** = ``524288``
  2448. .. container:: contribute
  2449. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2450. .. _class_RenderingDevice_constant_POST_PROCESSING_PASS:
  2451. .. rst-class:: classref-enumeration-constant
  2452. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **POST_PROCESSING_PASS** = ``589824``
  2453. .. container:: contribute
  2454. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2455. .. _class_RenderingDevice_constant_BLIT_PASS:
  2456. .. rst-class:: classref-enumeration-constant
  2457. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **BLIT_PASS** = ``655360``
  2458. .. container:: contribute
  2459. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2460. .. _class_RenderingDevice_constant_UI_PASS:
  2461. .. rst-class:: classref-enumeration-constant
  2462. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **UI_PASS** = ``720896``
  2463. .. container:: contribute
  2464. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2465. .. _class_RenderingDevice_constant_DEBUG_PASS:
  2466. .. rst-class:: classref-enumeration-constant
  2467. :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` **DEBUG_PASS** = ``786432``
  2468. .. container:: contribute
  2469. There is currently no description for this enum. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!
  2470. .. rst-class:: classref-item-separator
  2471. ----
  2472. .. _enum_RenderingDevice_DrawFlags:
  2473. .. rst-class:: classref-enumeration
  2474. flags **DrawFlags**: :ref:`๐Ÿ”—<enum_RenderingDevice_DrawFlags>`
  2475. .. _class_RenderingDevice_constant_DRAW_DEFAULT_ALL:
  2476. .. rst-class:: classref-enumeration-constant
  2477. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_DEFAULT_ALL** = ``0``
  2478. Do not clear or ignore any attachments.
  2479. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_0:
  2480. .. rst-class:: classref-enumeration-constant
  2481. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_0** = ``1``
  2482. Clear the first color attachment.
  2483. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_1:
  2484. .. rst-class:: classref-enumeration-constant
  2485. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_1** = ``2``
  2486. Clear the second color attachment.
  2487. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_2:
  2488. .. rst-class:: classref-enumeration-constant
  2489. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_2** = ``4``
  2490. Clear the third color attachment.
  2491. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_3:
  2492. .. rst-class:: classref-enumeration-constant
  2493. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_3** = ``8``
  2494. Clear the fourth color attachment.
  2495. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_4:
  2496. .. rst-class:: classref-enumeration-constant
  2497. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_4** = ``16``
  2498. Clear the fifth color attachment.
  2499. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_5:
  2500. .. rst-class:: classref-enumeration-constant
  2501. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_5** = ``32``
  2502. Clear the sixth color attachment.
  2503. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_6:
  2504. .. rst-class:: classref-enumeration-constant
  2505. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_6** = ``64``
  2506. Clear the seventh color attachment.
  2507. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_7:
  2508. .. rst-class:: classref-enumeration-constant
  2509. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_7** = ``128``
  2510. Clear the eighth color attachment.
  2511. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_MASK:
  2512. .. rst-class:: classref-enumeration-constant
  2513. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_MASK** = ``255``
  2514. Mask for clearing all color attachments.
  2515. .. _class_RenderingDevice_constant_DRAW_CLEAR_COLOR_ALL:
  2516. .. rst-class:: classref-enumeration-constant
  2517. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_COLOR_ALL** = ``255``
  2518. Clear all color attachments.
  2519. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_0:
  2520. .. rst-class:: classref-enumeration-constant
  2521. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_0** = ``256``
  2522. Ignore the previous contents of the first color attachment.
  2523. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_1:
  2524. .. rst-class:: classref-enumeration-constant
  2525. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_1** = ``512``
  2526. Ignore the previous contents of the second color attachment.
  2527. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_2:
  2528. .. rst-class:: classref-enumeration-constant
  2529. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_2** = ``1024``
  2530. Ignore the previous contents of the third color attachment.
  2531. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_3:
  2532. .. rst-class:: classref-enumeration-constant
  2533. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_3** = ``2048``
  2534. Ignore the previous contents of the fourth color attachment.
  2535. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_4:
  2536. .. rst-class:: classref-enumeration-constant
  2537. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_4** = ``4096``
  2538. Ignore the previous contents of the fifth color attachment.
  2539. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_5:
  2540. .. rst-class:: classref-enumeration-constant
  2541. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_5** = ``8192``
  2542. Ignore the previous contents of the sixth color attachment.
  2543. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_6:
  2544. .. rst-class:: classref-enumeration-constant
  2545. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_6** = ``16384``
  2546. Ignore the previous contents of the seventh color attachment.
  2547. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_7:
  2548. .. rst-class:: classref-enumeration-constant
  2549. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_7** = ``32768``
  2550. Ignore the previous contents of the eighth color attachment.
  2551. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_MASK:
  2552. .. rst-class:: classref-enumeration-constant
  2553. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_MASK** = ``65280``
  2554. Mask for ignoring all the previous contents of the color attachments.
  2555. .. _class_RenderingDevice_constant_DRAW_IGNORE_COLOR_ALL:
  2556. .. rst-class:: classref-enumeration-constant
  2557. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_COLOR_ALL** = ``65280``
  2558. Ignore the previous contents of all color attachments.
  2559. .. _class_RenderingDevice_constant_DRAW_CLEAR_DEPTH:
  2560. .. rst-class:: classref-enumeration-constant
  2561. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_DEPTH** = ``65536``
  2562. Clear the depth attachment.
  2563. .. _class_RenderingDevice_constant_DRAW_IGNORE_DEPTH:
  2564. .. rst-class:: classref-enumeration-constant
  2565. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_DEPTH** = ``131072``
  2566. Ignore the previous contents of the depth attachment.
  2567. .. _class_RenderingDevice_constant_DRAW_CLEAR_STENCIL:
  2568. .. rst-class:: classref-enumeration-constant
  2569. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_STENCIL** = ``262144``
  2570. Clear the stencil attachment.
  2571. .. _class_RenderingDevice_constant_DRAW_IGNORE_STENCIL:
  2572. .. rst-class:: classref-enumeration-constant
  2573. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_STENCIL** = ``524288``
  2574. Ignore the previous contents of the stencil attachment.
  2575. .. _class_RenderingDevice_constant_DRAW_CLEAR_ALL:
  2576. .. rst-class:: classref-enumeration-constant
  2577. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_CLEAR_ALL** = ``327935``
  2578. Clear all attachments.
  2579. .. _class_RenderingDevice_constant_DRAW_IGNORE_ALL:
  2580. .. rst-class:: classref-enumeration-constant
  2581. :ref:`DrawFlags<enum_RenderingDevice_DrawFlags>` **DRAW_IGNORE_ALL** = ``720640``
  2582. Ignore the previous contents of all attachments.
  2583. .. rst-class:: classref-section-separator
  2584. ----
  2585. .. rst-class:: classref-descriptions-group
  2586. Constants
  2587. ---------
  2588. .. _class_RenderingDevice_constant_INVALID_ID:
  2589. .. rst-class:: classref-constant
  2590. **INVALID_ID** = ``-1`` :ref:`๐Ÿ”—<class_RenderingDevice_constant_INVALID_ID>`
  2591. Returned by functions that return an ID if a value is invalid.
  2592. .. _class_RenderingDevice_constant_INVALID_FORMAT_ID:
  2593. .. rst-class:: classref-constant
  2594. **INVALID_FORMAT_ID** = ``-1`` :ref:`๐Ÿ”—<class_RenderingDevice_constant_INVALID_FORMAT_ID>`
  2595. Returned by functions that return a format ID if a value is invalid.
  2596. .. rst-class:: classref-section-separator
  2597. ----
  2598. .. rst-class:: classref-descriptions-group
  2599. Method Descriptions
  2600. -------------------
  2601. .. _class_RenderingDevice_method_barrier:
  2602. .. rst-class:: classref-method
  2603. |void| **barrier**\ (\ from\: |bitfield|\[:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\] = 32767, to\: |bitfield|\[:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\] = 32767\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_barrier>`
  2604. **Deprecated:** Barriers are automatically inserted by RenderingDevice.
  2605. This method does nothing.
  2606. .. rst-class:: classref-item-separator
  2607. ----
  2608. .. _class_RenderingDevice_method_buffer_clear:
  2609. .. rst-class:: classref-method
  2610. :ref:`Error<enum_@GlobalScope_Error>` **buffer_clear**\ (\ buffer\: :ref:`RID<class_RID>`, offset\: :ref:`int<class_int>`, size_bytes\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_buffer_clear>`
  2611. Clears the contents of the ``buffer``, clearing ``size_bytes`` bytes, starting at ``offset``.
  2612. Prints an error if:
  2613. - the size isn't a multiple of four
  2614. - the region specified by ``offset`` + ``size_bytes`` exceeds the buffer
  2615. - a draw list is currently active (created by :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`)
  2616. - a compute list is currently active (created by :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>`)
  2617. .. rst-class:: classref-item-separator
  2618. ----
  2619. .. _class_RenderingDevice_method_buffer_copy:
  2620. .. rst-class:: classref-method
  2621. :ref:`Error<enum_@GlobalScope_Error>` **buffer_copy**\ (\ src_buffer\: :ref:`RID<class_RID>`, dst_buffer\: :ref:`RID<class_RID>`, src_offset\: :ref:`int<class_int>`, dst_offset\: :ref:`int<class_int>`, size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_buffer_copy>`
  2622. Copies ``size`` bytes from the ``src_buffer`` at ``src_offset`` into ``dst_buffer`` at ``dst_offset``.
  2623. Prints an error if:
  2624. - ``size`` exceeds the size of either ``src_buffer`` or ``dst_buffer`` at their corresponding offsets
  2625. - a draw list is currently active (created by :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`)
  2626. - a compute list is currently active (created by :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>`)
  2627. .. rst-class:: classref-item-separator
  2628. ----
  2629. .. _class_RenderingDevice_method_buffer_get_data:
  2630. .. rst-class:: classref-method
  2631. :ref:`PackedByteArray<class_PackedByteArray>` **buffer_get_data**\ (\ buffer\: :ref:`RID<class_RID>`, offset_bytes\: :ref:`int<class_int>` = 0, size_bytes\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_buffer_get_data>`
  2632. Returns a copy of the data of the specified ``buffer``, optionally ``offset_bytes`` and ``size_bytes`` can be set to copy only a portion of the buffer.
  2633. \ **Note:** This method will block the GPU from working until the data is retrieved. Refer to :ref:`buffer_get_data_async<class_RenderingDevice_method_buffer_get_data_async>` for an alternative that returns the data in more performant way.
  2634. .. rst-class:: classref-item-separator
  2635. ----
  2636. .. _class_RenderingDevice_method_buffer_get_data_async:
  2637. .. rst-class:: classref-method
  2638. :ref:`Error<enum_@GlobalScope_Error>` **buffer_get_data_async**\ (\ buffer\: :ref:`RID<class_RID>`, callback\: :ref:`Callable<class_Callable>`, offset_bytes\: :ref:`int<class_int>` = 0, size_bytes\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_buffer_get_data_async>`
  2639. Asynchronous version of :ref:`buffer_get_data<class_RenderingDevice_method_buffer_get_data>`. RenderingDevice will call ``callback`` in a certain amount of frames with the data the buffer had at the time of the request.
  2640. \ **Note:** At the moment, the delay corresponds to the amount of frames specified by :ref:`ProjectSettings.rendering/rendering_device/vsync/frame_queue_size<class_ProjectSettings_property_rendering/rendering_device/vsync/frame_queue_size>`.
  2641. \ **Note:** Downloading large buffers can have a prohibitive cost for real-time even when using the asynchronous method due to hardware bandwidth limitations. When dealing with large resources, you can adjust settings such as :ref:`ProjectSettings.rendering/rendering_device/staging_buffer/block_size_kb<class_ProjectSettings_property_rendering/rendering_device/staging_buffer/block_size_kb>` to improve the transfer speed at the cost of extra memory.
  2642. ::
  2643. func _buffer_get_data_callback(array):
  2644. value = array.decode_u32(0)
  2645. ...
  2646. rd.buffer_get_data_async(buffer, _buffer_get_data_callback)
  2647. .. rst-class:: classref-item-separator
  2648. ----
  2649. .. _class_RenderingDevice_method_buffer_get_device_address:
  2650. .. rst-class:: classref-method
  2651. :ref:`int<class_int>` **buffer_get_device_address**\ (\ buffer\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_buffer_get_device_address>`
  2652. Returns the address of the given ``buffer`` which can be passed to shaders in any way to access underlying data. Buffer must have been created with this feature enabled.
  2653. \ **Note:** You must check that the GPU supports this functionality by calling :ref:`has_feature<class_RenderingDevice_method_has_feature>` with :ref:`SUPPORTS_BUFFER_DEVICE_ADDRESS<class_RenderingDevice_constant_SUPPORTS_BUFFER_DEVICE_ADDRESS>` as a parameter.
  2654. .. rst-class:: classref-item-separator
  2655. ----
  2656. .. _class_RenderingDevice_method_buffer_update:
  2657. .. rst-class:: classref-method
  2658. :ref:`Error<enum_@GlobalScope_Error>` **buffer_update**\ (\ buffer\: :ref:`RID<class_RID>`, offset\: :ref:`int<class_int>`, size_bytes\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_buffer_update>`
  2659. Updates a region of ``size_bytes`` bytes, starting at ``offset``, in the buffer, with the specified ``data``.
  2660. Prints an error if:
  2661. - the region specified by ``offset`` + ``size_bytes`` exceeds the buffer
  2662. - a draw list is currently active (created by :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`)
  2663. - a compute list is currently active (created by :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>`)
  2664. .. rst-class:: classref-item-separator
  2665. ----
  2666. .. _class_RenderingDevice_method_capture_timestamp:
  2667. .. rst-class:: classref-method
  2668. |void| **capture_timestamp**\ (\ name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_capture_timestamp>`
  2669. Creates a timestamp marker with the specified ``name``. This is used for performance reporting with the :ref:`get_captured_timestamp_cpu_time<class_RenderingDevice_method_get_captured_timestamp_cpu_time>`, :ref:`get_captured_timestamp_gpu_time<class_RenderingDevice_method_get_captured_timestamp_gpu_time>` and :ref:`get_captured_timestamp_name<class_RenderingDevice_method_get_captured_timestamp_name>` methods.
  2670. .. rst-class:: classref-item-separator
  2671. ----
  2672. .. _class_RenderingDevice_method_compute_list_add_barrier:
  2673. .. rst-class:: classref-method
  2674. |void| **compute_list_add_barrier**\ (\ compute_list\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_list_add_barrier>`
  2675. Raises a Vulkan compute barrier in the specified ``compute_list``.
  2676. .. rst-class:: classref-item-separator
  2677. ----
  2678. .. _class_RenderingDevice_method_compute_list_begin:
  2679. .. rst-class:: classref-method
  2680. :ref:`int<class_int>` **compute_list_begin**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_list_begin>`
  2681. Starts a list of compute commands created with the ``compute_*`` methods. The returned value should be passed to other ``compute_list_*`` functions.
  2682. Multiple compute lists cannot be created at the same time; you must finish the previous compute list first using :ref:`compute_list_end<class_RenderingDevice_method_compute_list_end>`.
  2683. A simple compute operation might look like this (code is not a complete example):
  2684. ::
  2685. var rd = RenderingDevice.new()
  2686. var compute_list = rd.compute_list_begin()
  2687. rd.compute_list_bind_compute_pipeline(compute_list, compute_shader_dilate_pipeline)
  2688. rd.compute_list_bind_uniform_set(compute_list, compute_base_uniform_set, 0)
  2689. rd.compute_list_bind_uniform_set(compute_list, dilate_uniform_set, 1)
  2690. for i in atlas_slices:
  2691. rd.compute_list_set_push_constant(compute_list, push_constant, push_constant.size())
  2692. rd.compute_list_dispatch(compute_list, group_size.x, group_size.y, group_size.z)
  2693. # No barrier, let them run all together.
  2694. rd.compute_list_end()
  2695. .. rst-class:: classref-item-separator
  2696. ----
  2697. .. _class_RenderingDevice_method_compute_list_bind_compute_pipeline:
  2698. .. rst-class:: classref-method
  2699. |void| **compute_list_bind_compute_pipeline**\ (\ compute_list\: :ref:`int<class_int>`, compute_pipeline\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_list_bind_compute_pipeline>`
  2700. Tells the GPU what compute pipeline to use when processing the compute list. If the shader has changed since the last time this function was called, Godot will unbind all descriptor sets and will re-bind them inside :ref:`compute_list_dispatch<class_RenderingDevice_method_compute_list_dispatch>`.
  2701. .. rst-class:: classref-item-separator
  2702. ----
  2703. .. _class_RenderingDevice_method_compute_list_bind_uniform_set:
  2704. .. rst-class:: classref-method
  2705. |void| **compute_list_bind_uniform_set**\ (\ compute_list\: :ref:`int<class_int>`, uniform_set\: :ref:`RID<class_RID>`, set_index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_list_bind_uniform_set>`
  2706. Binds the ``uniform_set`` to this ``compute_list``. Godot ensures that all textures in the uniform set have the correct Vulkan access masks. If Godot had to change access masks of textures, it will raise a Vulkan image memory barrier.
  2707. .. rst-class:: classref-item-separator
  2708. ----
  2709. .. _class_RenderingDevice_method_compute_list_dispatch:
  2710. .. rst-class:: classref-method
  2711. |void| **compute_list_dispatch**\ (\ compute_list\: :ref:`int<class_int>`, x_groups\: :ref:`int<class_int>`, y_groups\: :ref:`int<class_int>`, z_groups\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_list_dispatch>`
  2712. Submits the compute list for processing on the GPU. This is the compute equivalent to :ref:`draw_list_draw<class_RenderingDevice_method_draw_list_draw>`.
  2713. .. rst-class:: classref-item-separator
  2714. ----
  2715. .. _class_RenderingDevice_method_compute_list_dispatch_indirect:
  2716. .. rst-class:: classref-method
  2717. |void| **compute_list_dispatch_indirect**\ (\ compute_list\: :ref:`int<class_int>`, buffer\: :ref:`RID<class_RID>`, offset\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_list_dispatch_indirect>`
  2718. Submits the compute list for processing on the GPU with the given group counts stored in the ``buffer`` at ``offset``. Buffer must have been created with :ref:`STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT<class_RenderingDevice_constant_STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT>` flag.
  2719. .. rst-class:: classref-item-separator
  2720. ----
  2721. .. _class_RenderingDevice_method_compute_list_end:
  2722. .. rst-class:: classref-method
  2723. |void| **compute_list_end**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_list_end>`
  2724. Finishes a list of compute commands created with the ``compute_*`` methods.
  2725. .. rst-class:: classref-item-separator
  2726. ----
  2727. .. _class_RenderingDevice_method_compute_list_set_push_constant:
  2728. .. rst-class:: classref-method
  2729. |void| **compute_list_set_push_constant**\ (\ compute_list\: :ref:`int<class_int>`, buffer\: :ref:`PackedByteArray<class_PackedByteArray>`, size_bytes\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_list_set_push_constant>`
  2730. Sets the push constant data to ``buffer`` for the specified ``compute_list``. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in ``size_bytes`` (this can be obtained by calling the :ref:`PackedByteArray.size<class_PackedByteArray_method_size>` method on the passed ``buffer``).
  2731. .. rst-class:: classref-item-separator
  2732. ----
  2733. .. _class_RenderingDevice_method_compute_pipeline_create:
  2734. .. rst-class:: classref-method
  2735. :ref:`RID<class_RID>` **compute_pipeline_create**\ (\ shader\: :ref:`RID<class_RID>`, specialization_constants\: :ref:`Array<class_Array>`\[:ref:`RDPipelineSpecializationConstant<class_RDPipelineSpecializationConstant>`\] = []\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_pipeline_create>`
  2736. Creates a new compute pipeline. It can be accessed with the RID that is returned.
  2737. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  2738. .. rst-class:: classref-item-separator
  2739. ----
  2740. .. _class_RenderingDevice_method_compute_pipeline_is_valid:
  2741. .. rst-class:: classref-method
  2742. :ref:`bool<class_bool>` **compute_pipeline_is_valid**\ (\ compute_pipeline\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_compute_pipeline_is_valid>`
  2743. Returns ``true`` if the compute pipeline specified by the ``compute_pipeline`` RID is valid, ``false`` otherwise.
  2744. .. rst-class:: classref-item-separator
  2745. ----
  2746. .. _class_RenderingDevice_method_create_local_device:
  2747. .. rst-class:: classref-method
  2748. :ref:`RenderingDevice<class_RenderingDevice>` **create_local_device**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_create_local_device>`
  2749. Create a new local **RenderingDevice**. This is most useful for performing compute operations on the GPU independently from the rest of the engine.
  2750. .. rst-class:: classref-item-separator
  2751. ----
  2752. .. _class_RenderingDevice_method_draw_command_begin_label:
  2753. .. rst-class:: classref-method
  2754. |void| **draw_command_begin_label**\ (\ name\: :ref:`String<class_String>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_command_begin_label>`
  2755. Create a command buffer debug label region that can be displayed in third-party tools such as `RenderDoc <https://renderdoc.org/>`__. All regions must be ended with a :ref:`draw_command_end_label<class_RenderingDevice_method_draw_command_end_label>` call. When viewed from the linear series of submissions to a single queue, calls to :ref:`draw_command_begin_label<class_RenderingDevice_method_draw_command_begin_label>` and :ref:`draw_command_end_label<class_RenderingDevice_method_draw_command_end_label>` must be matched and balanced.
  2756. The ``VK_EXT_DEBUG_UTILS_EXTENSION_NAME`` Vulkan extension must be available and enabled for command buffer debug label region to work. See also :ref:`draw_command_end_label<class_RenderingDevice_method_draw_command_end_label>`.
  2757. .. rst-class:: classref-item-separator
  2758. ----
  2759. .. _class_RenderingDevice_method_draw_command_end_label:
  2760. .. rst-class:: classref-method
  2761. |void| **draw_command_end_label**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_command_end_label>`
  2762. Ends the command buffer debug label region started by a :ref:`draw_command_begin_label<class_RenderingDevice_method_draw_command_begin_label>` call.
  2763. .. rst-class:: classref-item-separator
  2764. ----
  2765. .. _class_RenderingDevice_method_draw_command_insert_label:
  2766. .. rst-class:: classref-method
  2767. |void| **draw_command_insert_label**\ (\ name\: :ref:`String<class_String>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_command_insert_label>`
  2768. **Deprecated:** Inserting labels no longer applies due to command reordering.
  2769. This method does nothing.
  2770. .. rst-class:: classref-item-separator
  2771. ----
  2772. .. _class_RenderingDevice_method_draw_list_begin:
  2773. .. rst-class:: classref-method
  2774. :ref:`int<class_int>` **draw_list_begin**\ (\ framebuffer\: :ref:`RID<class_RID>`, draw_flags\: |bitfield|\[:ref:`DrawFlags<enum_RenderingDevice_DrawFlags>`\] = 0, clear_color_values\: :ref:`PackedColorArray<class_PackedColorArray>` = PackedColorArray(), clear_depth_value\: :ref:`float<class_float>` = 1.0, clear_stencil_value\: :ref:`int<class_int>` = 0, region\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), breadcrumb\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_begin>`
  2775. Starts a list of raster drawing commands created with the ``draw_*`` methods. The returned value should be passed to other ``draw_list_*`` functions.
  2776. Multiple draw lists cannot be created at the same time; you must finish the previous draw list first using :ref:`draw_list_end<class_RenderingDevice_method_draw_list_end>`.
  2777. A simple drawing operation might look like this (code is not a complete example):
  2778. ::
  2779. var rd = RenderingDevice.new()
  2780. var clear_colors = PackedColorArray([Color(0, 0, 0, 0), Color(0, 0, 0, 0), Color(0, 0, 0, 0)])
  2781. var draw_list = rd.draw_list_begin(framebuffers[i], RenderingDevice.CLEAR_COLOR_ALL, clear_colors, true, 1.0f, true, 0, Rect2(), RenderingDevice.OPAQUE_PASS)
  2782. # Draw opaque.
  2783. rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline)
  2784. rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
  2785. rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
  2786. rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)
  2787. # Draw wire.
  2788. rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline_wire)
  2789. rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
  2790. rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
  2791. rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)
  2792. rd.draw_list_end()
  2793. The ``draw_flags`` indicates if the texture attachments of the framebuffer should be cleared or ignored. Only one of the two flags can be used for each individual attachment. Ignoring an attachment means that any contents that existed before the draw list will be completely discarded, reducing the memory bandwidth used by the render pass but producing garbage results if the pixels aren't replaced. The default behavior allows the engine to figure out the right operation to use if the texture is discardable, which can result in increased performance. See :ref:`RDTextureFormat<class_RDTextureFormat>` or :ref:`texture_set_discardable<class_RenderingDevice_method_texture_set_discardable>`.
  2794. The ``breadcrumb`` parameter can be an arbitrary 32-bit integer that is useful to diagnose GPU crashes. If Godot is built in dev or debug mode; when the GPU crashes Godot will dump all shaders that were being executed at the time of the crash and the breadcrumb is useful to diagnose what passes did those shaders belong to.
  2795. It does not affect rendering behavior and can be set to 0. It is recommended to use :ref:`BreadcrumbMarker<enum_RenderingDevice_BreadcrumbMarker>` enumerations for consistency but it's not required. It is also possible to use bitwise operations to add extra data. e.g.
  2796. ::
  2797. rd.draw_list_begin(fb[i], RenderingDevice.CLEAR_COLOR_ALL, clear_colors, true, 1.0f, true, 0, Rect2(), RenderingDevice.OPAQUE_PASS | 5)
  2798. .. rst-class:: classref-item-separator
  2799. ----
  2800. .. _class_RenderingDevice_method_draw_list_begin_for_screen:
  2801. .. rst-class:: classref-method
  2802. :ref:`int<class_int>` **draw_list_begin_for_screen**\ (\ screen\: :ref:`int<class_int>` = 0, clear_color\: :ref:`Color<class_Color>` = Color(0, 0, 0, 1)\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_begin_for_screen>`
  2803. High-level variant of :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`, with the parameters automatically being adjusted for drawing onto the window specified by the ``screen`` ID.
  2804. \ **Note:** Cannot be used with local RenderingDevices, as these don't have a screen. If called on a local RenderingDevice, :ref:`draw_list_begin_for_screen<class_RenderingDevice_method_draw_list_begin_for_screen>` returns :ref:`INVALID_ID<class_RenderingDevice_constant_INVALID_ID>`.
  2805. .. rst-class:: classref-item-separator
  2806. ----
  2807. .. _class_RenderingDevice_method_draw_list_begin_split:
  2808. .. rst-class:: classref-method
  2809. :ref:`PackedInt64Array<class_PackedInt64Array>` **draw_list_begin_split**\ (\ framebuffer\: :ref:`RID<class_RID>`, splits\: :ref:`int<class_int>`, initial_color_action\: :ref:`InitialAction<enum_RenderingDevice_InitialAction>`, final_color_action\: :ref:`FinalAction<enum_RenderingDevice_FinalAction>`, initial_depth_action\: :ref:`InitialAction<enum_RenderingDevice_InitialAction>`, final_depth_action\: :ref:`FinalAction<enum_RenderingDevice_FinalAction>`, clear_color_values\: :ref:`PackedColorArray<class_PackedColorArray>` = PackedColorArray(), clear_depth\: :ref:`float<class_float>` = 1.0, clear_stencil\: :ref:`int<class_int>` = 0, region\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0), storage_textures\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\] = []\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_begin_split>`
  2810. **Deprecated:** Split draw lists are used automatically by RenderingDevice.
  2811. This method does nothing and always returns an empty :ref:`PackedInt64Array<class_PackedInt64Array>`.
  2812. .. rst-class:: classref-item-separator
  2813. ----
  2814. .. _class_RenderingDevice_method_draw_list_bind_index_array:
  2815. .. rst-class:: classref-method
  2816. |void| **draw_list_bind_index_array**\ (\ draw_list\: :ref:`int<class_int>`, index_array\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_bind_index_array>`
  2817. Binds ``index_array`` to the specified ``draw_list``.
  2818. .. rst-class:: classref-item-separator
  2819. ----
  2820. .. _class_RenderingDevice_method_draw_list_bind_render_pipeline:
  2821. .. rst-class:: classref-method
  2822. |void| **draw_list_bind_render_pipeline**\ (\ draw_list\: :ref:`int<class_int>`, render_pipeline\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_bind_render_pipeline>`
  2823. Binds ``render_pipeline`` to the specified ``draw_list``.
  2824. .. rst-class:: classref-item-separator
  2825. ----
  2826. .. _class_RenderingDevice_method_draw_list_bind_uniform_set:
  2827. .. rst-class:: classref-method
  2828. |void| **draw_list_bind_uniform_set**\ (\ draw_list\: :ref:`int<class_int>`, uniform_set\: :ref:`RID<class_RID>`, set_index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_bind_uniform_set>`
  2829. Binds ``uniform_set`` to the specified ``draw_list``. A ``set_index`` must also be specified, which is an identifier starting from ``0`` that must match the one expected by the draw list.
  2830. .. rst-class:: classref-item-separator
  2831. ----
  2832. .. _class_RenderingDevice_method_draw_list_bind_vertex_array:
  2833. .. rst-class:: classref-method
  2834. |void| **draw_list_bind_vertex_array**\ (\ draw_list\: :ref:`int<class_int>`, vertex_array\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_bind_vertex_array>`
  2835. Binds ``vertex_array`` to the specified ``draw_list``.
  2836. .. rst-class:: classref-item-separator
  2837. ----
  2838. .. _class_RenderingDevice_method_draw_list_disable_scissor:
  2839. .. rst-class:: classref-method
  2840. |void| **draw_list_disable_scissor**\ (\ draw_list\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_disable_scissor>`
  2841. Removes and disables the scissor rectangle for the specified ``draw_list``. See also :ref:`draw_list_enable_scissor<class_RenderingDevice_method_draw_list_enable_scissor>`.
  2842. .. rst-class:: classref-item-separator
  2843. ----
  2844. .. _class_RenderingDevice_method_draw_list_draw:
  2845. .. rst-class:: classref-method
  2846. |void| **draw_list_draw**\ (\ draw_list\: :ref:`int<class_int>`, use_indices\: :ref:`bool<class_bool>`, instances\: :ref:`int<class_int>`, procedural_vertex_count\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_draw>`
  2847. Submits ``draw_list`` for rendering on the GPU. This is the raster equivalent to :ref:`compute_list_dispatch<class_RenderingDevice_method_compute_list_dispatch>`.
  2848. .. rst-class:: classref-item-separator
  2849. ----
  2850. .. _class_RenderingDevice_method_draw_list_draw_indirect:
  2851. .. rst-class:: classref-method
  2852. |void| **draw_list_draw_indirect**\ (\ draw_list\: :ref:`int<class_int>`, use_indices\: :ref:`bool<class_bool>`, buffer\: :ref:`RID<class_RID>`, offset\: :ref:`int<class_int>` = 0, draw_count\: :ref:`int<class_int>` = 1, stride\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_draw_indirect>`
  2853. Submits ``draw_list`` for rendering on the GPU with the given parameters stored in the ``buffer`` at ``offset``. Parameters being integers: vertex count, instance count, first vertex, first instance. And when using indices: index count, instance count, first index, vertex offset, first instance. Buffer must have been created with :ref:`STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT<class_RenderingDevice_constant_STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT>` flag.
  2854. .. rst-class:: classref-item-separator
  2855. ----
  2856. .. _class_RenderingDevice_method_draw_list_enable_scissor:
  2857. .. rst-class:: classref-method
  2858. |void| **draw_list_enable_scissor**\ (\ draw_list\: :ref:`int<class_int>`, rect\: :ref:`Rect2<class_Rect2>` = Rect2(0, 0, 0, 0)\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_enable_scissor>`
  2859. Creates a scissor rectangle and enables it for the specified ``draw_list``. Scissor rectangles are used for clipping by discarding fragments that fall outside a specified rectangular portion of the screen. See also :ref:`draw_list_disable_scissor<class_RenderingDevice_method_draw_list_disable_scissor>`.
  2860. \ **Note:** The specified ``rect`` is automatically intersected with the screen's dimensions, which means it cannot exceed the screen's dimensions.
  2861. .. rst-class:: classref-item-separator
  2862. ----
  2863. .. _class_RenderingDevice_method_draw_list_end:
  2864. .. rst-class:: classref-method
  2865. |void| **draw_list_end**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_end>`
  2866. Finishes a list of raster drawing commands created with the ``draw_*`` methods.
  2867. .. rst-class:: classref-item-separator
  2868. ----
  2869. .. _class_RenderingDevice_method_draw_list_set_blend_constants:
  2870. .. rst-class:: classref-method
  2871. |void| **draw_list_set_blend_constants**\ (\ draw_list\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_set_blend_constants>`
  2872. Sets blend constants for the specified ``draw_list`` to ``color``. Blend constants are used only if the graphics pipeline is created with :ref:`DYNAMIC_STATE_BLEND_CONSTANTS<class_RenderingDevice_constant_DYNAMIC_STATE_BLEND_CONSTANTS>` flag set.
  2873. .. rst-class:: classref-item-separator
  2874. ----
  2875. .. _class_RenderingDevice_method_draw_list_set_push_constant:
  2876. .. rst-class:: classref-method
  2877. |void| **draw_list_set_push_constant**\ (\ draw_list\: :ref:`int<class_int>`, buffer\: :ref:`PackedByteArray<class_PackedByteArray>`, size_bytes\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_set_push_constant>`
  2878. Sets the push constant data to ``buffer`` for the specified ``draw_list``. The shader determines how this binary data is used. The buffer's size in bytes must also be specified in ``size_bytes`` (this can be obtained by calling the :ref:`PackedByteArray.size<class_PackedByteArray_method_size>` method on the passed ``buffer``).
  2879. .. rst-class:: classref-item-separator
  2880. ----
  2881. .. _class_RenderingDevice_method_draw_list_switch_to_next_pass:
  2882. .. rst-class:: classref-method
  2883. :ref:`int<class_int>` **draw_list_switch_to_next_pass**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_switch_to_next_pass>`
  2884. Switches to the next draw pass.
  2885. .. rst-class:: classref-item-separator
  2886. ----
  2887. .. _class_RenderingDevice_method_draw_list_switch_to_next_pass_split:
  2888. .. rst-class:: classref-method
  2889. :ref:`PackedInt64Array<class_PackedInt64Array>` **draw_list_switch_to_next_pass_split**\ (\ splits\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_draw_list_switch_to_next_pass_split>`
  2890. **Deprecated:** Split draw lists are used automatically by RenderingDevice.
  2891. This method does nothing and always returns an empty :ref:`PackedInt64Array<class_PackedInt64Array>`.
  2892. .. rst-class:: classref-item-separator
  2893. ----
  2894. .. _class_RenderingDevice_method_framebuffer_create:
  2895. .. rst-class:: classref-method
  2896. :ref:`RID<class_RID>` **framebuffer_create**\ (\ textures\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], validate_with_format\: :ref:`int<class_int>` = -1, view_count\: :ref:`int<class_int>` = 1\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_framebuffer_create>`
  2897. Creates a new framebuffer. It can be accessed with the RID that is returned.
  2898. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  2899. .. rst-class:: classref-item-separator
  2900. ----
  2901. .. _class_RenderingDevice_method_framebuffer_create_empty:
  2902. .. rst-class:: classref-method
  2903. :ref:`RID<class_RID>` **framebuffer_create_empty**\ (\ size\: :ref:`Vector2i<class_Vector2i>`, samples\: :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` = 0, validate_with_format\: :ref:`int<class_int>` = -1\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_framebuffer_create_empty>`
  2904. Creates a new empty framebuffer. It can be accessed with the RID that is returned.
  2905. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  2906. .. rst-class:: classref-item-separator
  2907. ----
  2908. .. _class_RenderingDevice_method_framebuffer_create_multipass:
  2909. .. rst-class:: classref-method
  2910. :ref:`RID<class_RID>` **framebuffer_create_multipass**\ (\ textures\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], passes\: :ref:`Array<class_Array>`\[:ref:`RDFramebufferPass<class_RDFramebufferPass>`\], validate_with_format\: :ref:`int<class_int>` = -1, view_count\: :ref:`int<class_int>` = 1\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_framebuffer_create_multipass>`
  2911. Creates a new multipass framebuffer. It can be accessed with the RID that is returned.
  2912. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  2913. .. rst-class:: classref-item-separator
  2914. ----
  2915. .. _class_RenderingDevice_method_framebuffer_format_create:
  2916. .. rst-class:: classref-method
  2917. :ref:`int<class_int>` **framebuffer_format_create**\ (\ attachments\: :ref:`Array<class_Array>`\[:ref:`RDAttachmentFormat<class_RDAttachmentFormat>`\], view_count\: :ref:`int<class_int>` = 1\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_framebuffer_format_create>`
  2918. Creates a new framebuffer format with the specified ``attachments`` and ``view_count``. Returns the new framebuffer's unique framebuffer format ID.
  2919. If ``view_count`` is greater than or equal to ``2``, enables multiview which is used for VR rendering. This requires support for the Vulkan multiview extension.
  2920. .. rst-class:: classref-item-separator
  2921. ----
  2922. .. _class_RenderingDevice_method_framebuffer_format_create_empty:
  2923. .. rst-class:: classref-method
  2924. :ref:`int<class_int>` **framebuffer_format_create_empty**\ (\ samples\: :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_framebuffer_format_create_empty>`
  2925. Creates a new empty framebuffer format with the specified number of ``samples`` and returns its ID.
  2926. .. rst-class:: classref-item-separator
  2927. ----
  2928. .. _class_RenderingDevice_method_framebuffer_format_create_multipass:
  2929. .. rst-class:: classref-method
  2930. :ref:`int<class_int>` **framebuffer_format_create_multipass**\ (\ attachments\: :ref:`Array<class_Array>`\[:ref:`RDAttachmentFormat<class_RDAttachmentFormat>`\], passes\: :ref:`Array<class_Array>`\[:ref:`RDFramebufferPass<class_RDFramebufferPass>`\], view_count\: :ref:`int<class_int>` = 1\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_framebuffer_format_create_multipass>`
  2931. Creates a multipass framebuffer format with the specified ``attachments``, ``passes`` and ``view_count`` and returns its ID. If ``view_count`` is greater than or equal to ``2``, enables multiview which is used for VR rendering. This requires support for the Vulkan multiview extension.
  2932. .. rst-class:: classref-item-separator
  2933. ----
  2934. .. _class_RenderingDevice_method_framebuffer_format_get_texture_samples:
  2935. .. rst-class:: classref-method
  2936. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **framebuffer_format_get_texture_samples**\ (\ format\: :ref:`int<class_int>`, render_pass\: :ref:`int<class_int>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_framebuffer_format_get_texture_samples>`
  2937. Returns the number of texture samples used for the given framebuffer ``format`` ID (returned by :ref:`framebuffer_get_format<class_RenderingDevice_method_framebuffer_get_format>`).
  2938. .. rst-class:: classref-item-separator
  2939. ----
  2940. .. _class_RenderingDevice_method_framebuffer_get_format:
  2941. .. rst-class:: classref-method
  2942. :ref:`int<class_int>` **framebuffer_get_format**\ (\ framebuffer\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_framebuffer_get_format>`
  2943. Returns the format ID of the framebuffer specified by the ``framebuffer`` RID. This ID is guaranteed to be unique for the same formats and does not need to be freed.
  2944. .. rst-class:: classref-item-separator
  2945. ----
  2946. .. _class_RenderingDevice_method_framebuffer_is_valid:
  2947. .. rst-class:: classref-method
  2948. :ref:`bool<class_bool>` **framebuffer_is_valid**\ (\ framebuffer\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_framebuffer_is_valid>`
  2949. Returns ``true`` if the framebuffer specified by the ``framebuffer`` RID is valid, ``false`` otherwise.
  2950. .. rst-class:: classref-item-separator
  2951. ----
  2952. .. _class_RenderingDevice_method_free_rid:
  2953. .. rst-class:: classref-method
  2954. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_free_rid>`
  2955. Tries to free an object in the RenderingDevice. To avoid memory leaks, this should be called after using an object as memory management does not occur automatically when using RenderingDevice directly.
  2956. .. rst-class:: classref-item-separator
  2957. ----
  2958. .. _class_RenderingDevice_method_full_barrier:
  2959. .. rst-class:: classref-method
  2960. |void| **full_barrier**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_full_barrier>`
  2961. **Deprecated:** Barriers are automatically inserted by RenderingDevice.
  2962. This method does nothing.
  2963. .. rst-class:: classref-item-separator
  2964. ----
  2965. .. _class_RenderingDevice_method_get_captured_timestamp_cpu_time:
  2966. .. rst-class:: classref-method
  2967. :ref:`int<class_int>` **get_captured_timestamp_cpu_time**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_captured_timestamp_cpu_time>`
  2968. Returns the timestamp in CPU time for the rendering step specified by ``index`` (in microseconds since the engine started). See also :ref:`get_captured_timestamp_gpu_time<class_RenderingDevice_method_get_captured_timestamp_gpu_time>` and :ref:`capture_timestamp<class_RenderingDevice_method_capture_timestamp>`.
  2969. .. rst-class:: classref-item-separator
  2970. ----
  2971. .. _class_RenderingDevice_method_get_captured_timestamp_gpu_time:
  2972. .. rst-class:: classref-method
  2973. :ref:`int<class_int>` **get_captured_timestamp_gpu_time**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_captured_timestamp_gpu_time>`
  2974. Returns the timestamp in GPU time for the rendering step specified by ``index`` (in microseconds since the engine started). See also :ref:`get_captured_timestamp_cpu_time<class_RenderingDevice_method_get_captured_timestamp_cpu_time>` and :ref:`capture_timestamp<class_RenderingDevice_method_capture_timestamp>`.
  2975. .. rst-class:: classref-item-separator
  2976. ----
  2977. .. _class_RenderingDevice_method_get_captured_timestamp_name:
  2978. .. rst-class:: classref-method
  2979. :ref:`String<class_String>` **get_captured_timestamp_name**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_captured_timestamp_name>`
  2980. Returns the timestamp's name for the rendering step specified by ``index``. See also :ref:`capture_timestamp<class_RenderingDevice_method_capture_timestamp>`.
  2981. .. rst-class:: classref-item-separator
  2982. ----
  2983. .. _class_RenderingDevice_method_get_captured_timestamps_count:
  2984. .. rst-class:: classref-method
  2985. :ref:`int<class_int>` **get_captured_timestamps_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_captured_timestamps_count>`
  2986. Returns the total number of timestamps (rendering steps) available for profiling.
  2987. .. rst-class:: classref-item-separator
  2988. ----
  2989. .. _class_RenderingDevice_method_get_captured_timestamps_frame:
  2990. .. rst-class:: classref-method
  2991. :ref:`int<class_int>` **get_captured_timestamps_frame**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_captured_timestamps_frame>`
  2992. Returns the index of the last frame rendered that has rendering timestamps available for querying.
  2993. .. rst-class:: classref-item-separator
  2994. ----
  2995. .. _class_RenderingDevice_method_get_device_allocation_count:
  2996. .. rst-class:: classref-method
  2997. :ref:`int<class_int>` **get_device_allocation_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_device_allocation_count>`
  2998. Returns how many allocations the GPU has performed for internal driver structures.
  2999. This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
  3000. .. rst-class:: classref-item-separator
  3001. ----
  3002. .. _class_RenderingDevice_method_get_device_allocs_by_object_type:
  3003. .. rst-class:: classref-method
  3004. :ref:`int<class_int>` **get_device_allocs_by_object_type**\ (\ type\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_device_allocs_by_object_type>`
  3005. Same as :ref:`get_device_allocation_count<class_RenderingDevice_method_get_device_allocation_count>` but filtered for a given object type.
  3006. The type argument must be in range ``[0; get_tracked_object_type_count - 1]``. If :ref:`get_tracked_object_type_count<class_RenderingDevice_method_get_tracked_object_type_count>` is 0, then type argument is ignored and always returns 0.
  3007. This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
  3008. .. rst-class:: classref-item-separator
  3009. ----
  3010. .. _class_RenderingDevice_method_get_device_memory_by_object_type:
  3011. .. rst-class:: classref-method
  3012. :ref:`int<class_int>` **get_device_memory_by_object_type**\ (\ type\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_device_memory_by_object_type>`
  3013. Same as :ref:`get_device_total_memory<class_RenderingDevice_method_get_device_total_memory>` but filtered for a given object type.
  3014. The type argument must be in range ``[0; get_tracked_object_type_count - 1]``. If :ref:`get_tracked_object_type_count<class_RenderingDevice_method_get_tracked_object_type_count>` is 0, then type argument is ignored and always returns 0.
  3015. This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
  3016. .. rst-class:: classref-item-separator
  3017. ----
  3018. .. _class_RenderingDevice_method_get_device_name:
  3019. .. rst-class:: classref-method
  3020. :ref:`String<class_String>` **get_device_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_device_name>`
  3021. Returns the name of the video adapter (e.g. "GeForce GTX 1080/PCIe/SSE2"). Equivalent to :ref:`RenderingServer.get_video_adapter_name<class_RenderingServer_method_get_video_adapter_name>`. See also :ref:`get_device_vendor_name<class_RenderingDevice_method_get_device_vendor_name>`.
  3022. .. rst-class:: classref-item-separator
  3023. ----
  3024. .. _class_RenderingDevice_method_get_device_pipeline_cache_uuid:
  3025. .. rst-class:: classref-method
  3026. :ref:`String<class_String>` **get_device_pipeline_cache_uuid**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_device_pipeline_cache_uuid>`
  3027. Returns the universally unique identifier for the pipeline cache. This is used to cache shader files on disk, which avoids shader recompilations on subsequent engine runs. This UUID varies depending on the graphics card model, but also the driver version. Therefore, updating graphics drivers will invalidate the shader cache.
  3028. .. rst-class:: classref-item-separator
  3029. ----
  3030. .. _class_RenderingDevice_method_get_device_total_memory:
  3031. .. rst-class:: classref-method
  3032. :ref:`int<class_int>` **get_device_total_memory**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_device_total_memory>`
  3033. Returns how much bytes the GPU is using.
  3034. This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
  3035. .. rst-class:: classref-item-separator
  3036. ----
  3037. .. _class_RenderingDevice_method_get_device_vendor_name:
  3038. .. rst-class:: classref-method
  3039. :ref:`String<class_String>` **get_device_vendor_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_device_vendor_name>`
  3040. Returns the vendor of the video adapter (e.g. "NVIDIA Corporation"). Equivalent to :ref:`RenderingServer.get_video_adapter_vendor<class_RenderingServer_method_get_video_adapter_vendor>`. See also :ref:`get_device_name<class_RenderingDevice_method_get_device_name>`.
  3041. .. rst-class:: classref-item-separator
  3042. ----
  3043. .. _class_RenderingDevice_method_get_driver_allocation_count:
  3044. .. rst-class:: classref-method
  3045. :ref:`int<class_int>` **get_driver_allocation_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_driver_allocation_count>`
  3046. Returns how many allocations the GPU driver has performed for internal driver structures.
  3047. This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
  3048. .. rst-class:: classref-item-separator
  3049. ----
  3050. .. _class_RenderingDevice_method_get_driver_allocs_by_object_type:
  3051. .. rst-class:: classref-method
  3052. :ref:`int<class_int>` **get_driver_allocs_by_object_type**\ (\ type\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_driver_allocs_by_object_type>`
  3053. Same as :ref:`get_driver_allocation_count<class_RenderingDevice_method_get_driver_allocation_count>` but filtered for a given object type.
  3054. The type argument must be in range ``[0; get_tracked_object_type_count - 1]``. If :ref:`get_tracked_object_type_count<class_RenderingDevice_method_get_tracked_object_type_count>` is 0, then type argument is ignored and always returns 0.
  3055. This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
  3056. .. rst-class:: classref-item-separator
  3057. ----
  3058. .. _class_RenderingDevice_method_get_driver_and_device_memory_report:
  3059. .. rst-class:: classref-method
  3060. :ref:`String<class_String>` **get_driver_and_device_memory_report**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_driver_and_device_memory_report>`
  3061. Returns string report in CSV format using the following methods:
  3062. - :ref:`get_tracked_object_name<class_RenderingDevice_method_get_tracked_object_name>`\
  3063. - :ref:`get_tracked_object_type_count<class_RenderingDevice_method_get_tracked_object_type_count>`\
  3064. - :ref:`get_driver_total_memory<class_RenderingDevice_method_get_driver_total_memory>`\
  3065. - :ref:`get_driver_allocation_count<class_RenderingDevice_method_get_driver_allocation_count>`\
  3066. - :ref:`get_driver_memory_by_object_type<class_RenderingDevice_method_get_driver_memory_by_object_type>`\
  3067. - :ref:`get_driver_allocs_by_object_type<class_RenderingDevice_method_get_driver_allocs_by_object_type>`\
  3068. - :ref:`get_device_total_memory<class_RenderingDevice_method_get_device_total_memory>`\
  3069. - :ref:`get_device_allocation_count<class_RenderingDevice_method_get_device_allocation_count>`\
  3070. - :ref:`get_device_memory_by_object_type<class_RenderingDevice_method_get_device_memory_by_object_type>`\
  3071. - :ref:`get_device_allocs_by_object_type<class_RenderingDevice_method_get_device_allocs_by_object_type>`\
  3072. This is only used by Vulkan in debug builds. Godot must also be started with the ``--extra-gpu-memory-tracking`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`.
  3073. .. rst-class:: classref-item-separator
  3074. ----
  3075. .. _class_RenderingDevice_method_get_driver_memory_by_object_type:
  3076. .. rst-class:: classref-method
  3077. :ref:`int<class_int>` **get_driver_memory_by_object_type**\ (\ type\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_driver_memory_by_object_type>`
  3078. Same as :ref:`get_driver_total_memory<class_RenderingDevice_method_get_driver_total_memory>` but filtered for a given object type.
  3079. The type argument must be in range ``[0; get_tracked_object_type_count - 1]``. If :ref:`get_tracked_object_type_count<class_RenderingDevice_method_get_tracked_object_type_count>` is 0, then type argument is ignored and always returns 0.
  3080. This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
  3081. .. rst-class:: classref-item-separator
  3082. ----
  3083. .. _class_RenderingDevice_method_get_driver_resource:
  3084. .. rst-class:: classref-method
  3085. :ref:`int<class_int>` **get_driver_resource**\ (\ resource\: :ref:`DriverResource<enum_RenderingDevice_DriverResource>`, rid\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_get_driver_resource>`
  3086. Returns the unique identifier of the driver ``resource`` for the specified ``rid``. Some driver resource types ignore the specified ``rid`` (see :ref:`DriverResource<enum_RenderingDevice_DriverResource>` descriptions). ``index`` is always ignored but must be specified anyway.
  3087. .. rst-class:: classref-item-separator
  3088. ----
  3089. .. _class_RenderingDevice_method_get_driver_total_memory:
  3090. .. rst-class:: classref-method
  3091. :ref:`int<class_int>` **get_driver_total_memory**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_driver_total_memory>`
  3092. Returns how much bytes the GPU driver is using for internal driver structures.
  3093. This is only used by Vulkan in debug builds and can return 0 when this information is not tracked or unknown.
  3094. .. rst-class:: classref-item-separator
  3095. ----
  3096. .. _class_RenderingDevice_method_get_frame_delay:
  3097. .. rst-class:: classref-method
  3098. :ref:`int<class_int>` **get_frame_delay**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_frame_delay>`
  3099. Returns the frame count kept by the graphics API. Higher values result in higher input lag, but with more consistent throughput. For the main **RenderingDevice**, frames are cycled (usually 3 with triple-buffered V-Sync enabled). However, local **RenderingDevice**\ s only have 1 frame.
  3100. .. rst-class:: classref-item-separator
  3101. ----
  3102. .. _class_RenderingDevice_method_get_memory_usage:
  3103. .. rst-class:: classref-method
  3104. :ref:`int<class_int>` **get_memory_usage**\ (\ type\: :ref:`MemoryType<enum_RenderingDevice_MemoryType>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_memory_usage>`
  3105. Returns the memory usage in bytes corresponding to the given ``type``. When using Vulkan, these statistics are calculated by `Vulkan Memory Allocator <https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator>`__.
  3106. .. rst-class:: classref-item-separator
  3107. ----
  3108. .. _class_RenderingDevice_method_get_perf_report:
  3109. .. rst-class:: classref-method
  3110. :ref:`String<class_String>` **get_perf_report**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_perf_report>`
  3111. Returns a string with a performance report from the past frame. Updates every frame.
  3112. .. rst-class:: classref-item-separator
  3113. ----
  3114. .. _class_RenderingDevice_method_get_tracked_object_name:
  3115. .. rst-class:: classref-method
  3116. :ref:`String<class_String>` **get_tracked_object_name**\ (\ type_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_tracked_object_name>`
  3117. Returns the name of the type of object for the given ``type_index``. This value must be in range ``[0; get_tracked_object_type_count - 1]``. If :ref:`get_tracked_object_type_count<class_RenderingDevice_method_get_tracked_object_type_count>` is 0, then type argument is ignored and always returns the same string.
  3118. The return value is important because it gives meaning to the types passed to :ref:`get_driver_memory_by_object_type<class_RenderingDevice_method_get_driver_memory_by_object_type>`, :ref:`get_driver_allocs_by_object_type<class_RenderingDevice_method_get_driver_allocs_by_object_type>`, :ref:`get_device_memory_by_object_type<class_RenderingDevice_method_get_device_memory_by_object_type>`, and :ref:`get_device_allocs_by_object_type<class_RenderingDevice_method_get_device_allocs_by_object_type>`. Examples of strings it can return (not exhaustive):
  3119. - DEVICE_MEMORY
  3120. - PIPELINE_CACHE
  3121. - SWAPCHAIN_KHR
  3122. - COMMAND_POOL
  3123. Thus if e.g. ``get_tracked_object_name(5)`` returns "COMMAND_POOL", then ``get_device_memory_by_object_type(5)`` returns the bytes used by the GPU for command pools.
  3124. This is only used by Vulkan in debug builds. Godot must also be started with the ``--extra-gpu-memory-tracking`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`.
  3125. .. rst-class:: classref-item-separator
  3126. ----
  3127. .. _class_RenderingDevice_method_get_tracked_object_type_count:
  3128. .. rst-class:: classref-method
  3129. :ref:`int<class_int>` **get_tracked_object_type_count**\ (\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_get_tracked_object_type_count>`
  3130. Returns how many types of trackable objects are.
  3131. This is only used by Vulkan in debug builds. Godot must also be started with the ``--extra-gpu-memory-tracking`` :doc:`command line argument <../tutorials/editor/command_line_tutorial>`.
  3132. .. rst-class:: classref-item-separator
  3133. ----
  3134. .. _class_RenderingDevice_method_has_feature:
  3135. .. rst-class:: classref-method
  3136. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Features<enum_RenderingDevice_Features>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_has_feature>`
  3137. Returns ``true`` if the ``feature`` is supported by the GPU.
  3138. .. rst-class:: classref-item-separator
  3139. ----
  3140. .. _class_RenderingDevice_method_index_array_create:
  3141. .. rst-class:: classref-method
  3142. :ref:`RID<class_RID>` **index_array_create**\ (\ index_buffer\: :ref:`RID<class_RID>`, index_offset\: :ref:`int<class_int>`, index_count\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_index_array_create>`
  3143. Creates a new index array. It can be accessed with the RID that is returned.
  3144. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3145. .. rst-class:: classref-item-separator
  3146. ----
  3147. .. _class_RenderingDevice_method_index_buffer_create:
  3148. .. rst-class:: classref-method
  3149. :ref:`RID<class_RID>` **index_buffer_create**\ (\ size_indices\: :ref:`int<class_int>`, format\: :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray(), use_restart_indices\: :ref:`bool<class_bool>` = false, enable_device_address\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_index_buffer_create>`
  3150. Creates a new index buffer. It can be accessed with the RID that is returned.
  3151. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3152. Optionally, set ``enable_device_address`` if you wish to use :ref:`buffer_get_device_address<class_RenderingDevice_method_buffer_get_device_address>` functionality and the GPU supports it.
  3153. .. rst-class:: classref-item-separator
  3154. ----
  3155. .. _class_RenderingDevice_method_limit_get:
  3156. .. rst-class:: classref-method
  3157. :ref:`int<class_int>` **limit_get**\ (\ limit\: :ref:`Limit<enum_RenderingDevice_Limit>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_limit_get>`
  3158. Returns the value of the specified ``limit``. This limit varies depending on the current graphics hardware (and sometimes the driver version). If the given limit is exceeded, rendering errors will occur.
  3159. Limits for various graphics hardware can be found in the `Vulkan Hardware Database <https://vulkan.gpuinfo.org/>`__.
  3160. .. rst-class:: classref-item-separator
  3161. ----
  3162. .. _class_RenderingDevice_method_render_pipeline_create:
  3163. .. rst-class:: classref-method
  3164. :ref:`RID<class_RID>` **render_pipeline_create**\ (\ shader\: :ref:`RID<class_RID>`, framebuffer_format\: :ref:`int<class_int>`, vertex_format\: :ref:`int<class_int>`, primitive\: :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>`, rasterization_state\: :ref:`RDPipelineRasterizationState<class_RDPipelineRasterizationState>`, multisample_state\: :ref:`RDPipelineMultisampleState<class_RDPipelineMultisampleState>`, stencil_state\: :ref:`RDPipelineDepthStencilState<class_RDPipelineDepthStencilState>`, color_blend_state\: :ref:`RDPipelineColorBlendState<class_RDPipelineColorBlendState>`, dynamic_state_flags\: |bitfield|\[:ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>`\] = 0, for_render_pass\: :ref:`int<class_int>` = 0, specialization_constants\: :ref:`Array<class_Array>`\[:ref:`RDPipelineSpecializationConstant<class_RDPipelineSpecializationConstant>`\] = []\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_render_pipeline_create>`
  3165. Creates a new render pipeline. It can be accessed with the RID that is returned.
  3166. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3167. .. rst-class:: classref-item-separator
  3168. ----
  3169. .. _class_RenderingDevice_method_render_pipeline_is_valid:
  3170. .. rst-class:: classref-method
  3171. :ref:`bool<class_bool>` **render_pipeline_is_valid**\ (\ render_pipeline\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_render_pipeline_is_valid>`
  3172. Returns ``true`` if the render pipeline specified by the ``render_pipeline`` RID is valid, ``false`` otherwise.
  3173. .. rst-class:: classref-item-separator
  3174. ----
  3175. .. _class_RenderingDevice_method_sampler_create:
  3176. .. rst-class:: classref-method
  3177. :ref:`RID<class_RID>` **sampler_create**\ (\ state\: :ref:`RDSamplerState<class_RDSamplerState>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_sampler_create>`
  3178. Creates a new sampler. It can be accessed with the RID that is returned.
  3179. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3180. .. rst-class:: classref-item-separator
  3181. ----
  3182. .. _class_RenderingDevice_method_sampler_is_format_supported_for_filter:
  3183. .. rst-class:: classref-method
  3184. :ref:`bool<class_bool>` **sampler_is_format_supported_for_filter**\ (\ format\: :ref:`DataFormat<enum_RenderingDevice_DataFormat>`, sampler_filter\: :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>`\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_sampler_is_format_supported_for_filter>`
  3185. Returns ``true`` if implementation supports using a texture of ``format`` with the given ``sampler_filter``.
  3186. .. rst-class:: classref-item-separator
  3187. ----
  3188. .. _class_RenderingDevice_method_screen_get_framebuffer_format:
  3189. .. rst-class:: classref-method
  3190. :ref:`int<class_int>` **screen_get_framebuffer_format**\ (\ screen\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_screen_get_framebuffer_format>`
  3191. Returns the framebuffer format of the given screen.
  3192. \ **Note:** Only the main **RenderingDevice** returned by :ref:`RenderingServer.get_rendering_device<class_RenderingServer_method_get_rendering_device>` has a format. If called on a local **RenderingDevice**, this method prints an error and returns :ref:`INVALID_ID<class_RenderingDevice_constant_INVALID_ID>`.
  3193. .. rst-class:: classref-item-separator
  3194. ----
  3195. .. _class_RenderingDevice_method_screen_get_height:
  3196. .. rst-class:: classref-method
  3197. :ref:`int<class_int>` **screen_get_height**\ (\ screen\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_screen_get_height>`
  3198. Returns the window height matching the graphics API context for the given window ID (in pixels). Despite the parameter being named ``screen``, this returns the *window* size. See also :ref:`screen_get_width<class_RenderingDevice_method_screen_get_width>`.
  3199. \ **Note:** Only the main **RenderingDevice** returned by :ref:`RenderingServer.get_rendering_device<class_RenderingServer_method_get_rendering_device>` has a height. If called on a local **RenderingDevice**, this method prints an error and returns :ref:`INVALID_ID<class_RenderingDevice_constant_INVALID_ID>`.
  3200. .. rst-class:: classref-item-separator
  3201. ----
  3202. .. _class_RenderingDevice_method_screen_get_width:
  3203. .. rst-class:: classref-method
  3204. :ref:`int<class_int>` **screen_get_width**\ (\ screen\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_screen_get_width>`
  3205. Returns the window width matching the graphics API context for the given window ID (in pixels). Despite the parameter being named ``screen``, this returns the *window* size. See also :ref:`screen_get_height<class_RenderingDevice_method_screen_get_height>`.
  3206. \ **Note:** Only the main **RenderingDevice** returned by :ref:`RenderingServer.get_rendering_device<class_RenderingServer_method_get_rendering_device>` has a width. If called on a local **RenderingDevice**, this method prints an error and returns :ref:`INVALID_ID<class_RenderingDevice_constant_INVALID_ID>`.
  3207. .. rst-class:: classref-item-separator
  3208. ----
  3209. .. _class_RenderingDevice_method_set_resource_name:
  3210. .. rst-class:: classref-method
  3211. |void| **set_resource_name**\ (\ id\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_set_resource_name>`
  3212. Sets the resource name for ``id`` to ``name``. This is used for debugging with third-party tools such as `RenderDoc <https://renderdoc.org/>`__.
  3213. The following types of resources can be named: texture, sampler, vertex buffer, index buffer, uniform buffer, texture buffer, storage buffer, uniform set buffer, shader, render pipeline and compute pipeline. Framebuffers cannot be named. Attempting to name an incompatible resource type will print an error.
  3214. \ **Note:** Resource names are only set when the engine runs in verbose mode (:ref:`OS.is_stdout_verbose<class_OS_method_is_stdout_verbose>` = ``true``), or when using an engine build compiled with the ``dev_mode=yes`` SCons option. The graphics driver must also support the ``VK_EXT_DEBUG_UTILS_EXTENSION_NAME`` Vulkan extension for named resources to work.
  3215. .. rst-class:: classref-item-separator
  3216. ----
  3217. .. _class_RenderingDevice_method_shader_compile_binary_from_spirv:
  3218. .. rst-class:: classref-method
  3219. :ref:`PackedByteArray<class_PackedByteArray>` **shader_compile_binary_from_spirv**\ (\ spirv_data\: :ref:`RDShaderSPIRV<class_RDShaderSPIRV>`, name\: :ref:`String<class_String>` = ""\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_shader_compile_binary_from_spirv>`
  3220. Compiles a binary shader from ``spirv_data`` and returns the compiled binary data as a :ref:`PackedByteArray<class_PackedByteArray>`. This compiled shader is specific to the GPU model and driver version used; it will not work on different GPU models or even different driver versions. See also :ref:`shader_compile_spirv_from_source<class_RenderingDevice_method_shader_compile_spirv_from_source>`.
  3221. \ ``name`` is an optional human-readable name that can be given to the compiled shader for organizational purposes.
  3222. .. rst-class:: classref-item-separator
  3223. ----
  3224. .. _class_RenderingDevice_method_shader_compile_spirv_from_source:
  3225. .. rst-class:: classref-method
  3226. :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` **shader_compile_spirv_from_source**\ (\ shader_source\: :ref:`RDShaderSource<class_RDShaderSource>`, allow_cache\: :ref:`bool<class_bool>` = true\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_shader_compile_spirv_from_source>`
  3227. Compiles a SPIR-V from the shader source code in ``shader_source`` and returns the SPIR-V as a :ref:`RDShaderSPIRV<class_RDShaderSPIRV>`. This intermediate language shader is portable across different GPU models and driver versions, but cannot be run directly by GPUs until compiled into a binary shader using :ref:`shader_compile_binary_from_spirv<class_RenderingDevice_method_shader_compile_binary_from_spirv>`.
  3228. If ``allow_cache`` is ``true``, make use of the shader cache generated by Godot. This avoids a potentially lengthy shader compilation step if the shader is already in cache. If ``allow_cache`` is ``false``, Godot's shader cache is ignored and the shader will always be recompiled.
  3229. .. rst-class:: classref-item-separator
  3230. ----
  3231. .. _class_RenderingDevice_method_shader_create_from_bytecode:
  3232. .. rst-class:: classref-method
  3233. :ref:`RID<class_RID>` **shader_create_from_bytecode**\ (\ binary_data\: :ref:`PackedByteArray<class_PackedByteArray>`, placeholder_rid\: :ref:`RID<class_RID>` = RID()\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_shader_create_from_bytecode>`
  3234. Creates a new shader instance from a binary compiled shader. It can be accessed with the RID that is returned.
  3235. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method. See also :ref:`shader_compile_binary_from_spirv<class_RenderingDevice_method_shader_compile_binary_from_spirv>` and :ref:`shader_create_from_spirv<class_RenderingDevice_method_shader_create_from_spirv>`.
  3236. .. rst-class:: classref-item-separator
  3237. ----
  3238. .. _class_RenderingDevice_method_shader_create_from_spirv:
  3239. .. rst-class:: classref-method
  3240. :ref:`RID<class_RID>` **shader_create_from_spirv**\ (\ spirv_data\: :ref:`RDShaderSPIRV<class_RDShaderSPIRV>`, name\: :ref:`String<class_String>` = ""\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_shader_create_from_spirv>`
  3241. Creates a new shader instance from SPIR-V intermediate code. It can be accessed with the RID that is returned.
  3242. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method. See also :ref:`shader_compile_spirv_from_source<class_RenderingDevice_method_shader_compile_spirv_from_source>` and :ref:`shader_create_from_bytecode<class_RenderingDevice_method_shader_create_from_bytecode>`.
  3243. .. rst-class:: classref-item-separator
  3244. ----
  3245. .. _class_RenderingDevice_method_shader_create_placeholder:
  3246. .. rst-class:: classref-method
  3247. :ref:`RID<class_RID>` **shader_create_placeholder**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_shader_create_placeholder>`
  3248. Create a placeholder RID by allocating an RID without initializing it for use in :ref:`shader_create_from_bytecode<class_RenderingDevice_method_shader_create_from_bytecode>`. This allows you to create an RID for a shader and pass it around, but defer compiling the shader to a later time.
  3249. .. rst-class:: classref-item-separator
  3250. ----
  3251. .. _class_RenderingDevice_method_shader_get_vertex_input_attribute_mask:
  3252. .. rst-class:: classref-method
  3253. :ref:`int<class_int>` **shader_get_vertex_input_attribute_mask**\ (\ shader\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_shader_get_vertex_input_attribute_mask>`
  3254. Returns the internal vertex input mask. Internally, the vertex input mask is an unsigned integer consisting of the locations (specified in GLSL via. ``layout(location = ...)``) of the input variables (specified in GLSL by the ``in`` keyword).
  3255. .. rst-class:: classref-item-separator
  3256. ----
  3257. .. _class_RenderingDevice_method_storage_buffer_create:
  3258. .. rst-class:: classref-method
  3259. :ref:`RID<class_RID>` **storage_buffer_create**\ (\ size_bytes\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray(), usage\: |bitfield|\[:ref:`StorageBufferUsage<enum_RenderingDevice_StorageBufferUsage>`\] = 0\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_storage_buffer_create>`
  3260. Creates a `storage buffer <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ with the specified ``data`` and ``usage``. It can be accessed with the RID that is returned.
  3261. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3262. .. rst-class:: classref-item-separator
  3263. ----
  3264. .. _class_RenderingDevice_method_submit:
  3265. .. rst-class:: classref-method
  3266. |void| **submit**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_submit>`
  3267. Pushes the frame setup and draw command buffers then marks the local device as currently processing (which allows calling :ref:`sync<class_RenderingDevice_method_sync>`).
  3268. \ **Note:** Only available in local RenderingDevices.
  3269. .. rst-class:: classref-item-separator
  3270. ----
  3271. .. _class_RenderingDevice_method_sync:
  3272. .. rst-class:: classref-method
  3273. |void| **sync**\ (\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_sync>`
  3274. 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.
  3275. \ **Note:** Only available in local RenderingDevices.
  3276. \ **Note:** :ref:`sync<class_RenderingDevice_method_sync>` can only be called after a :ref:`submit<class_RenderingDevice_method_submit>`.
  3277. .. rst-class:: classref-item-separator
  3278. ----
  3279. .. _class_RenderingDevice_method_texture_buffer_create:
  3280. .. rst-class:: classref-method
  3281. :ref:`RID<class_RID>` **texture_buffer_create**\ (\ size_bytes\: :ref:`int<class_int>`, format\: :ref:`DataFormat<enum_RenderingDevice_DataFormat>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray()\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_buffer_create>`
  3282. Creates a new texture buffer. It can be accessed with the RID that is returned.
  3283. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3284. .. rst-class:: classref-item-separator
  3285. ----
  3286. .. _class_RenderingDevice_method_texture_clear:
  3287. .. rst-class:: classref-method
  3288. :ref:`Error<enum_@GlobalScope_Error>` **texture_clear**\ (\ texture\: :ref:`RID<class_RID>`, color\: :ref:`Color<class_Color>`, base_mipmap\: :ref:`int<class_int>`, mipmap_count\: :ref:`int<class_int>`, base_layer\: :ref:`int<class_int>`, layer_count\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_clear>`
  3289. Clears the specified ``texture`` by replacing all of its pixels with the specified ``color``. ``base_mipmap`` and ``mipmap_count`` determine which mipmaps of the texture are affected by this clear operation, while ``base_layer`` and ``layer_count`` determine which layers of a 3D texture (or texture array) are affected by this clear operation. For 2D textures (which only have one layer by design), ``base_layer`` must be ``0`` and ``layer_count`` must be ``1``.
  3290. \ **Note:** ``texture`` can't be cleared while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>`) to clear this texture.
  3291. .. rst-class:: classref-item-separator
  3292. ----
  3293. .. _class_RenderingDevice_method_texture_copy:
  3294. .. rst-class:: classref-method
  3295. :ref:`Error<enum_@GlobalScope_Error>` **texture_copy**\ (\ from_texture\: :ref:`RID<class_RID>`, to_texture\: :ref:`RID<class_RID>`, from_pos\: :ref:`Vector3<class_Vector3>`, to_pos\: :ref:`Vector3<class_Vector3>`, size\: :ref:`Vector3<class_Vector3>`, src_mipmap\: :ref:`int<class_int>`, dst_mipmap\: :ref:`int<class_int>`, src_layer\: :ref:`int<class_int>`, dst_layer\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_copy>`
  3296. Copies the ``from_texture`` to ``to_texture`` with the specified ``from_pos``, ``to_pos`` and ``size`` coordinates. The Z axis of the ``from_pos``, ``to_pos`` and ``size`` must be ``0`` for 2-dimensional textures. Source and destination mipmaps/layers must also be specified, with these parameters being ``0`` for textures without mipmaps or single-layer textures. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the texture copy was successful or :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` otherwise.
  3297. \ **Note:** ``from_texture`` texture can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>`) to copy this texture.
  3298. \ **Note:** ``from_texture`` texture requires the :ref:`TEXTURE_USAGE_CAN_COPY_FROM_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT>` to be retrieved.
  3299. \ **Note:** ``to_texture`` can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>`) to copy this texture.
  3300. \ **Note:** ``to_texture`` requires the :ref:`TEXTURE_USAGE_CAN_COPY_TO_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_TO_BIT>` to be retrieved.
  3301. \ **Note:** ``from_texture`` and ``to_texture`` must be of the same type (color or depth).
  3302. .. rst-class:: classref-item-separator
  3303. ----
  3304. .. _class_RenderingDevice_method_texture_create:
  3305. .. rst-class:: classref-method
  3306. :ref:`RID<class_RID>` **texture_create**\ (\ format\: :ref:`RDTextureFormat<class_RDTextureFormat>`, view\: :ref:`RDTextureView<class_RDTextureView>`, data\: :ref:`Array<class_Array>`\[:ref:`PackedByteArray<class_PackedByteArray>`\] = []\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_create>`
  3307. Creates a new texture. It can be accessed with the RID that is returned.
  3308. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3309. \ **Note:** Not to be confused with :ref:`RenderingServer.texture_2d_create<class_RenderingServer_method_texture_2d_create>`, which creates the Godot-specific :ref:`Texture2D<class_Texture2D>` resource as opposed to the graphics API's own texture type.
  3310. .. rst-class:: classref-item-separator
  3311. ----
  3312. .. _class_RenderingDevice_method_texture_create_from_extension:
  3313. .. rst-class:: classref-method
  3314. :ref:`RID<class_RID>` **texture_create_from_extension**\ (\ type\: :ref:`TextureType<enum_RenderingDevice_TextureType>`, format\: :ref:`DataFormat<enum_RenderingDevice_DataFormat>`, samples\: :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>`\], image\: :ref:`int<class_int>`, width\: :ref:`int<class_int>`, height\: :ref:`int<class_int>`, depth\: :ref:`int<class_int>`, layers\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_create_from_extension>`
  3315. Returns an RID for an existing ``image`` (``VkImage``) with the given ``type``, ``format``, ``samples``, ``usage_flags``, ``width``, ``height``, ``depth``, and ``layers``. This can be used to allow Godot to render onto foreign images.
  3316. .. rst-class:: classref-item-separator
  3317. ----
  3318. .. _class_RenderingDevice_method_texture_create_shared:
  3319. .. rst-class:: classref-method
  3320. :ref:`RID<class_RID>` **texture_create_shared**\ (\ view\: :ref:`RDTextureView<class_RDTextureView>`, with_texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_create_shared>`
  3321. Creates a shared texture using the specified ``view`` and the texture information from ``with_texture``.
  3322. .. rst-class:: classref-item-separator
  3323. ----
  3324. .. _class_RenderingDevice_method_texture_create_shared_from_slice:
  3325. .. rst-class:: classref-method
  3326. :ref:`RID<class_RID>` **texture_create_shared_from_slice**\ (\ view\: :ref:`RDTextureView<class_RDTextureView>`, with_texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, mipmap\: :ref:`int<class_int>`, mipmaps\: :ref:`int<class_int>` = 1, slice_type\: :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` = 0\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_create_shared_from_slice>`
  3327. Creates a shared texture using the specified ``view`` and the texture information from ``with_texture``'s ``layer`` and ``mipmap``. The number of included mipmaps from the original texture can be controlled using the ``mipmaps`` parameter. Only relevant for textures with multiple layers, such as 3D textures, texture arrays and cubemaps. For single-layer textures, use :ref:`texture_create_shared<class_RenderingDevice_method_texture_create_shared>`.
  3328. For 2D textures (which only have one layer), ``layer`` must be ``0``.
  3329. \ **Note:** Layer slicing is only supported for 2D texture arrays, not 3D textures or cubemaps.
  3330. .. rst-class:: classref-item-separator
  3331. ----
  3332. .. _class_RenderingDevice_method_texture_get_data:
  3333. .. rst-class:: classref-method
  3334. :ref:`PackedByteArray<class_PackedByteArray>` **texture_get_data**\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_get_data>`
  3335. Returns the ``texture`` data for the specified ``layer`` as raw binary data. For 2D textures (which only have one layer), ``layer`` must be ``0``.
  3336. \ **Note:** ``texture`` can't be retrieved while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>`) to retrieve this texture. Otherwise, an error is printed and a empty :ref:`PackedByteArray<class_PackedByteArray>` is returned.
  3337. \ **Note:** ``texture`` requires the :ref:`TEXTURE_USAGE_CAN_COPY_FROM_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT>` to be retrieved. Otherwise, an error is printed and a empty :ref:`PackedByteArray<class_PackedByteArray>` is returned.
  3338. \ **Note:** This method will block the GPU from working until the data is retrieved. Refer to :ref:`texture_get_data_async<class_RenderingDevice_method_texture_get_data_async>` for an alternative that returns the data in more performant way.
  3339. .. rst-class:: classref-item-separator
  3340. ----
  3341. .. _class_RenderingDevice_method_texture_get_data_async:
  3342. .. rst-class:: classref-method
  3343. :ref:`Error<enum_@GlobalScope_Error>` **texture_get_data_async**\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, callback\: :ref:`Callable<class_Callable>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_get_data_async>`
  3344. Asynchronous version of :ref:`texture_get_data<class_RenderingDevice_method_texture_get_data>`. RenderingDevice will call ``callback`` in a certain amount of frames with the data the texture had at the time of the request.
  3345. \ **Note:** At the moment, the delay corresponds to the amount of frames specified by :ref:`ProjectSettings.rendering/rendering_device/vsync/frame_queue_size<class_ProjectSettings_property_rendering/rendering_device/vsync/frame_queue_size>`.
  3346. \ **Note:** Downloading large textures can have a prohibitive cost for real-time even when using the asynchronous method due to hardware bandwidth limitations. When dealing with large resources, you can adjust settings such as :ref:`ProjectSettings.rendering/rendering_device/staging_buffer/texture_download_region_size_px<class_ProjectSettings_property_rendering/rendering_device/staging_buffer/texture_download_region_size_px>` and :ref:`ProjectSettings.rendering/rendering_device/staging_buffer/block_size_kb<class_ProjectSettings_property_rendering/rendering_device/staging_buffer/block_size_kb>` to improve the transfer speed at the cost of extra memory.
  3347. ::
  3348. func _texture_get_data_callback(array):
  3349. value = array.decode_u32(0)
  3350. ...
  3351. rd.texture_get_data_async(texture, 0, _texture_get_data_callback)
  3352. .. rst-class:: classref-item-separator
  3353. ----
  3354. .. _class_RenderingDevice_method_texture_get_format:
  3355. .. rst-class:: classref-method
  3356. :ref:`RDTextureFormat<class_RDTextureFormat>` **texture_get_format**\ (\ texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_get_format>`
  3357. Returns the data format used to create this texture.
  3358. .. rst-class:: classref-item-separator
  3359. ----
  3360. .. _class_RenderingDevice_method_texture_get_native_handle:
  3361. .. rst-class:: classref-method
  3362. :ref:`int<class_int>` **texture_get_native_handle**\ (\ texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_get_native_handle>`
  3363. **Deprecated:** Use :ref:`get_driver_resource<class_RenderingDevice_method_get_driver_resource>` with :ref:`DRIVER_RESOURCE_TEXTURE<class_RenderingDevice_constant_DRIVER_RESOURCE_TEXTURE>` instead.
  3364. Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
  3365. \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan).
  3366. .. rst-class:: classref-item-separator
  3367. ----
  3368. .. _class_RenderingDevice_method_texture_is_discardable:
  3369. .. rst-class:: classref-method
  3370. :ref:`bool<class_bool>` **texture_is_discardable**\ (\ texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_is_discardable>`
  3371. Returns ``true`` if the ``texture`` is discardable, ``false`` otherwise. See :ref:`RDTextureFormat<class_RDTextureFormat>` or :ref:`texture_set_discardable<class_RenderingDevice_method_texture_set_discardable>`.
  3372. .. rst-class:: classref-item-separator
  3373. ----
  3374. .. _class_RenderingDevice_method_texture_is_format_supported_for_usage:
  3375. .. rst-class:: classref-method
  3376. :ref:`bool<class_bool>` **texture_is_format_supported_for_usage**\ (\ format\: :ref:`DataFormat<enum_RenderingDevice_DataFormat>`, usage_flags\: |bitfield|\[:ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>`\]\ ) |const| :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_is_format_supported_for_usage>`
  3377. Returns ``true`` if the specified ``format`` is supported for the given ``usage_flags``, ``false`` otherwise.
  3378. .. rst-class:: classref-item-separator
  3379. ----
  3380. .. _class_RenderingDevice_method_texture_is_shared:
  3381. .. rst-class:: classref-method
  3382. :ref:`bool<class_bool>` **texture_is_shared**\ (\ texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_is_shared>`
  3383. Returns ``true`` if the ``texture`` is shared, ``false`` otherwise. See :ref:`RDTextureView<class_RDTextureView>`.
  3384. .. rst-class:: classref-item-separator
  3385. ----
  3386. .. _class_RenderingDevice_method_texture_is_valid:
  3387. .. rst-class:: classref-method
  3388. :ref:`bool<class_bool>` **texture_is_valid**\ (\ texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_is_valid>`
  3389. Returns ``true`` if the ``texture`` is valid, ``false`` otherwise.
  3390. .. rst-class:: classref-item-separator
  3391. ----
  3392. .. _class_RenderingDevice_method_texture_resolve_multisample:
  3393. .. rst-class:: classref-method
  3394. :ref:`Error<enum_@GlobalScope_Error>` **texture_resolve_multisample**\ (\ from_texture\: :ref:`RID<class_RID>`, to_texture\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_resolve_multisample>`
  3395. Resolves the ``from_texture`` texture onto ``to_texture`` with multisample antialiasing enabled. This must be used when rendering a framebuffer for MSAA to work. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` otherwise.
  3396. \ **Note:** ``from_texture`` and ``to_texture`` textures must have the same dimension, format and type (color or depth).
  3397. \ **Note:** ``from_texture`` can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>`) to resolve this texture.
  3398. \ **Note:** ``from_texture`` requires the :ref:`TEXTURE_USAGE_CAN_COPY_FROM_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT>` to be retrieved.
  3399. \ **Note:** ``from_texture`` must be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
  3400. \ **Note:** ``to_texture`` can't be copied while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>`) to resolve this texture.
  3401. \ **Note:** ``to_texture`` texture requires the :ref:`TEXTURE_USAGE_CAN_COPY_TO_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_TO_BIT>` to be retrieved.
  3402. \ **Note:** ``to_texture`` texture must **not** be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
  3403. .. rst-class:: classref-item-separator
  3404. ----
  3405. .. _class_RenderingDevice_method_texture_set_discardable:
  3406. .. rst-class:: classref-method
  3407. |void| **texture_set_discardable**\ (\ texture\: :ref:`RID<class_RID>`, discardable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_set_discardable>`
  3408. Updates the discardable property of ``texture``.
  3409. If a texture is discardable, its contents do not need to be preserved between frames. This flag is only relevant when the texture is used as target in a draw list.
  3410. This information is used by **RenderingDevice** to figure out if a texture's contents can be discarded, eliminating unnecessary writes to memory and boosting performance.
  3411. .. rst-class:: classref-item-separator
  3412. ----
  3413. .. _class_RenderingDevice_method_texture_update:
  3414. .. rst-class:: classref-method
  3415. :ref:`Error<enum_@GlobalScope_Error>` **texture_update**\ (\ texture\: :ref:`RID<class_RID>`, layer\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_texture_update>`
  3416. Updates texture data with new data, replacing the previous data in place. The updated texture data must have the same dimensions and format. For 2D textures (which only have one layer), ``layer`` must be ``0``. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` if the update was successful, :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` otherwise.
  3417. \ **Note:** Updating textures is forbidden during creation of a draw or compute list.
  3418. \ **Note:** The existing ``texture`` can't be updated while a draw list that uses it as part of a framebuffer is being created. Ensure the draw list is finalized (and that the color/depth texture using it is not set to :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>`) to update this texture.
  3419. \ **Note:** The existing ``texture`` requires the :ref:`TEXTURE_USAGE_CAN_UPDATE_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_UPDATE_BIT>` to be updatable.
  3420. .. rst-class:: classref-item-separator
  3421. ----
  3422. .. _class_RenderingDevice_method_uniform_buffer_create:
  3423. .. rst-class:: classref-method
  3424. :ref:`RID<class_RID>` **uniform_buffer_create**\ (\ size_bytes\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray(), enable_device_address\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_uniform_buffer_create>`
  3425. Creates a new uniform buffer. It can be accessed with the RID that is returned.
  3426. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3427. Optionally, set ``enable_device_address`` if you wish to use :ref:`buffer_get_device_address<class_RenderingDevice_method_buffer_get_device_address>` functionality and the GPU supports it.
  3428. .. rst-class:: classref-item-separator
  3429. ----
  3430. .. _class_RenderingDevice_method_uniform_set_create:
  3431. .. rst-class:: classref-method
  3432. :ref:`RID<class_RID>` **uniform_set_create**\ (\ uniforms\: :ref:`Array<class_Array>`\[:ref:`RDUniform<class_RDUniform>`\], shader\: :ref:`RID<class_RID>`, shader_set\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_uniform_set_create>`
  3433. Creates a new uniform set. It can be accessed with the RID that is returned.
  3434. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3435. .. rst-class:: classref-item-separator
  3436. ----
  3437. .. _class_RenderingDevice_method_uniform_set_is_valid:
  3438. .. rst-class:: classref-method
  3439. :ref:`bool<class_bool>` **uniform_set_is_valid**\ (\ uniform_set\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_uniform_set_is_valid>`
  3440. Checks if the ``uniform_set`` is valid, i.e. is owned.
  3441. .. rst-class:: classref-item-separator
  3442. ----
  3443. .. _class_RenderingDevice_method_vertex_array_create:
  3444. .. rst-class:: classref-method
  3445. :ref:`RID<class_RID>` **vertex_array_create**\ (\ vertex_count\: :ref:`int<class_int>`, vertex_format\: :ref:`int<class_int>`, src_buffers\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], offsets\: :ref:`PackedInt64Array<class_PackedInt64Array>` = PackedInt64Array()\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_vertex_array_create>`
  3446. Creates a vertex array based on the specified buffers. Optionally, ``offsets`` (in bytes) may be defined for each buffer.
  3447. .. rst-class:: classref-item-separator
  3448. ----
  3449. .. _class_RenderingDevice_method_vertex_buffer_create:
  3450. .. rst-class:: classref-method
  3451. :ref:`RID<class_RID>` **vertex_buffer_create**\ (\ size_bytes\: :ref:`int<class_int>`, data\: :ref:`PackedByteArray<class_PackedByteArray>` = PackedByteArray(), use_as_storage\: :ref:`bool<class_bool>` = false, enable_device_address\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_vertex_buffer_create>`
  3452. It can be accessed with the RID that is returned.
  3453. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  3454. Optionally, set ``enable_device_address`` if you wish to use :ref:`buffer_get_device_address<class_RenderingDevice_method_buffer_get_device_address>` functionality and the GPU supports it.
  3455. .. rst-class:: classref-item-separator
  3456. ----
  3457. .. _class_RenderingDevice_method_vertex_format_create:
  3458. .. rst-class:: classref-method
  3459. :ref:`int<class_int>` **vertex_format_create**\ (\ vertex_descriptions\: :ref:`Array<class_Array>`\[:ref:`RDVertexAttribute<class_RDVertexAttribute>`\]\ ) :ref:`๐Ÿ”—<class_RenderingDevice_method_vertex_format_create>`
  3460. Creates a new vertex format with the specified ``vertex_descriptions``. Returns a unique vertex format ID corresponding to the newly created vertex format.
  3461. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  3462. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  3463. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  3464. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  3465. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  3466. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  3467. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  3468. .. |void| replace:: :abbr:`void (No return value.)`