class_renderingdevice.rst 409 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654
  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>` **(** |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> from=32767, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> to=32767 **)** |
  30. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`buffer_clear<class_RenderingDevice_method_buffer_clear>` **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset, :ref:`int<class_int>` size_bytes, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)** |
  32. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`buffer_get_data<class_RenderingDevice_method_buffer_get_data>` **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset_bytes=0, :ref:`int<class_int>` size_bytes=0 **)** |
  34. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`buffer_update<class_RenderingDevice_method_buffer_update>` **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset, :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)** |
  36. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | void | :ref:`capture_timestamp<class_RenderingDevice_method_capture_timestamp>` **(** :ref:`String<class_String>` name **)** |
  38. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | void | :ref:`compute_list_add_barrier<class_RenderingDevice_method_compute_list_add_barrier>` **(** :ref:`int<class_int>` compute_list **)** |
  40. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`int<class_int>` | :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>` **(** :ref:`bool<class_bool>` allow_draw_overlap=false **)** |
  42. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`compute_list_bind_compute_pipeline<class_RenderingDevice_method_compute_list_bind_compute_pipeline>` **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` compute_pipeline **)** |
  44. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`compute_list_bind_uniform_set<class_RenderingDevice_method_compute_list_bind_uniform_set>` **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)** |
  46. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`compute_list_dispatch<class_RenderingDevice_method_compute_list_dispatch>` **(** :ref:`int<class_int>` compute_list, :ref:`int<class_int>` x_groups, :ref:`int<class_int>` y_groups, :ref:`int<class_int>` z_groups **)** |
  48. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`compute_list_end<class_RenderingDevice_method_compute_list_end>` **(** |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)** |
  50. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`compute_list_set_push_constant<class_RenderingDevice_method_compute_list_set_push_constant>` **(** :ref:`int<class_int>` compute_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)** |
  52. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`RID<class_RID>` | :ref:`compute_pipeline_create<class_RenderingDevice_method_compute_pipeline_create>` **(** :ref:`RID<class_RID>` shader, :ref:`RDPipelineSpecializationConstant[]<class_RDPipelineSpecializationConstant>` specialization_constants=[] **)** |
  54. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`bool<class_bool>` | :ref:`compute_pipeline_is_valid<class_RenderingDevice_method_compute_pipeline_is_valid>` **(** :ref:`RID<class_RID>` compute_pipeline **)** |
  56. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_device<class_RenderingDevice_method_create_local_device>` **(** **)** |
  58. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | void | :ref:`draw_command_begin_label<class_RenderingDevice_method_draw_command_begin_label>` **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)** |
  60. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`draw_command_end_label<class_RenderingDevice_method_draw_command_end_label>` **(** **)** |
  62. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`draw_command_insert_label<class_RenderingDevice_method_draw_command_insert_label>` **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)** |
  64. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`int<class_int>` | :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>` **(** :ref:`RID<class_RID>` framebuffer, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_color_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_color_action, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_depth_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_depth_action, :ref:`PackedColorArray<class_PackedColorArray>` clear_color_values=PackedColorArray(), :ref:`float<class_float>` clear_depth=1.0, :ref:`int<class_int>` clear_stencil=0, :ref:`Rect2<class_Rect2>` region=Rect2(0, 0, 0, 0), :ref:`RID[]<class_RID>` storage_textures=[] **)** |
  66. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`int<class_int>` | :ref:`draw_list_begin_for_screen<class_RenderingDevice_method_draw_list_begin_for_screen>` **(** :ref:`int<class_int>` screen=0, :ref:`Color<class_Color>` clear_color=Color(0, 0, 0, 1) **)** |
  68. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`draw_list_begin_split<class_RenderingDevice_method_draw_list_begin_split>` **(** :ref:`RID<class_RID>` framebuffer, :ref:`int<class_int>` splits, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_color_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_color_action, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_depth_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_depth_action, :ref:`PackedColorArray<class_PackedColorArray>` clear_color_values=PackedColorArray(), :ref:`float<class_float>` clear_depth=1.0, :ref:`int<class_int>` clear_stencil=0, :ref:`Rect2<class_Rect2>` region=Rect2(0, 0, 0, 0), :ref:`RID[]<class_RID>` storage_textures=[] **)** |
  70. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`draw_list_bind_index_array<class_RenderingDevice_method_draw_list_bind_index_array>` **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` index_array **)** |
  72. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`draw_list_bind_render_pipeline<class_RenderingDevice_method_draw_list_bind_render_pipeline>` **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` render_pipeline **)** |
  74. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | void | :ref:`draw_list_bind_uniform_set<class_RenderingDevice_method_draw_list_bind_uniform_set>` **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)** |
  76. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`draw_list_bind_vertex_array<class_RenderingDevice_method_draw_list_bind_vertex_array>` **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` vertex_array **)** |
  78. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`draw_list_disable_scissor<class_RenderingDevice_method_draw_list_disable_scissor>` **(** :ref:`int<class_int>` draw_list **)** |
  80. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | void | :ref:`draw_list_draw<class_RenderingDevice_method_draw_list_draw>` **(** :ref:`int<class_int>` draw_list, :ref:`bool<class_bool>` use_indices, :ref:`int<class_int>` instances, :ref:`int<class_int>` procedural_vertex_count=0 **)** |
  82. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`draw_list_enable_scissor<class_RenderingDevice_method_draw_list_enable_scissor>` **(** :ref:`int<class_int>` draw_list, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)** |
  84. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`draw_list_end<class_RenderingDevice_method_draw_list_end>` **(** |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)** |
  86. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | void | :ref:`draw_list_set_blend_constants<class_RenderingDevice_method_draw_list_set_blend_constants>` **(** :ref:`int<class_int>` draw_list, :ref:`Color<class_Color>` color **)** |
  88. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`draw_list_set_push_constant<class_RenderingDevice_method_draw_list_set_push_constant>` **(** :ref:`int<class_int>` draw_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)** |
  90. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`int<class_int>` | :ref:`draw_list_switch_to_next_pass<class_RenderingDevice_method_draw_list_switch_to_next_pass>` **(** **)** |
  92. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`draw_list_switch_to_next_pass_split<class_RenderingDevice_method_draw_list_switch_to_next_pass_split>` **(** :ref:`int<class_int>` splits **)** |
  94. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`RID<class_RID>` | :ref:`framebuffer_create<class_RenderingDevice_method_framebuffer_create>` **(** :ref:`RID[]<class_RID>` textures, :ref:`int<class_int>` validate_with_format=-1, :ref:`int<class_int>` view_count=1 **)** |
  96. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`RID<class_RID>` | :ref:`framebuffer_create_empty<class_RenderingDevice_method_framebuffer_create_empty>` **(** :ref:`Vector2i<class_Vector2i>` size, :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples=0, :ref:`int<class_int>` validate_with_format=-1 **)** |
  98. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`RID<class_RID>` | :ref:`framebuffer_create_multipass<class_RenderingDevice_method_framebuffer_create_multipass>` **(** :ref:`RID[]<class_RID>` textures, :ref:`RDFramebufferPass[]<class_RDFramebufferPass>` passes, :ref:`int<class_int>` validate_with_format=-1, :ref:`int<class_int>` view_count=1 **)** |
  100. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`int<class_int>` | :ref:`framebuffer_format_create<class_RenderingDevice_method_framebuffer_format_create>` **(** :ref:`RDAttachmentFormat[]<class_RDAttachmentFormat>` attachments, :ref:`int<class_int>` view_count=1 **)** |
  102. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`int<class_int>` | :ref:`framebuffer_format_create_empty<class_RenderingDevice_method_framebuffer_format_create_empty>` **(** :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples=0 **)** |
  104. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`int<class_int>` | :ref:`framebuffer_format_create_multipass<class_RenderingDevice_method_framebuffer_format_create_multipass>` **(** :ref:`RDAttachmentFormat[]<class_RDAttachmentFormat>` attachments, :ref:`RDFramebufferPass[]<class_RDFramebufferPass>` passes, :ref:`int<class_int>` view_count=1 **)** |
  106. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` | :ref:`framebuffer_format_get_texture_samples<class_RenderingDevice_method_framebuffer_format_get_texture_samples>` **(** :ref:`int<class_int>` format, :ref:`int<class_int>` render_pass=0 **)** |
  108. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`int<class_int>` | :ref:`framebuffer_get_format<class_RenderingDevice_method_framebuffer_get_format>` **(** :ref:`RID<class_RID>` framebuffer **)** |
  110. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`bool<class_bool>` | :ref:`framebuffer_is_valid<class_RenderingDevice_method_framebuffer_is_valid>` **(** :ref:`RID<class_RID>` framebuffer **)** |const| |
  112. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | void | :ref:`free_rid<class_RenderingDevice_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  114. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | void | :ref:`full_barrier<class_RenderingDevice_method_full_barrier>` **(** **)** |
  116. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`int<class_int>` | :ref:`get_captured_timestamp_cpu_time<class_RenderingDevice_method_get_captured_timestamp_cpu_time>` **(** :ref:`int<class_int>` index **)** |const| |
  118. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`int<class_int>` | :ref:`get_captured_timestamp_gpu_time<class_RenderingDevice_method_get_captured_timestamp_gpu_time>` **(** :ref:`int<class_int>` index **)** |const| |
  120. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`String<class_String>` | :ref:`get_captured_timestamp_name<class_RenderingDevice_method_get_captured_timestamp_name>` **(** :ref:`int<class_int>` index **)** |const| |
  122. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`int<class_int>` | :ref:`get_captured_timestamps_count<class_RenderingDevice_method_get_captured_timestamps_count>` **(** **)** |const| |
  124. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`int<class_int>` | :ref:`get_captured_timestamps_frame<class_RenderingDevice_method_get_captured_timestamps_frame>` **(** **)** |const| |
  126. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`String<class_String>` | :ref:`get_device_name<class_RenderingDevice_method_get_device_name>` **(** **)** |const| |
  128. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`String<class_String>` | :ref:`get_device_pipeline_cache_uuid<class_RenderingDevice_method_get_device_pipeline_cache_uuid>` **(** **)** |const| |
  130. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`String<class_String>` | :ref:`get_device_vendor_name<class_RenderingDevice_method_get_device_vendor_name>` **(** **)** |const| |
  132. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`int<class_int>` | :ref:`get_driver_resource<class_RenderingDevice_method_get_driver_resource>` **(** :ref:`DriverResource<enum_RenderingDevice_DriverResource>` resource, :ref:`RID<class_RID>` rid, :ref:`int<class_int>` index **)** |
  134. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`int<class_int>` | :ref:`get_frame_delay<class_RenderingDevice_method_get_frame_delay>` **(** **)** |const| |
  136. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`int<class_int>` | :ref:`get_memory_usage<class_RenderingDevice_method_get_memory_usage>` **(** :ref:`MemoryType<enum_RenderingDevice_MemoryType>` type **)** |const| |
  138. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`RID<class_RID>` | :ref:`index_array_create<class_RenderingDevice_method_index_array_create>` **(** :ref:`RID<class_RID>` index_buffer, :ref:`int<class_int>` index_offset, :ref:`int<class_int>` index_count **)** |
  140. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | :ref:`RID<class_RID>` | :ref:`index_buffer_create<class_RenderingDevice_method_index_buffer_create>` **(** :ref:`int<class_int>` size_indices, :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` format, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`bool<class_bool>` use_restart_indices=false **)** |
  142. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`int<class_int>` | :ref:`limit_get<class_RenderingDevice_method_limit_get>` **(** :ref:`Limit<enum_RenderingDevice_Limit>` limit **)** |const| |
  144. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | :ref:`RID<class_RID>` | :ref:`render_pipeline_create<class_RenderingDevice_method_render_pipeline_create>` **(** :ref:`RID<class_RID>` shader, :ref:`int<class_int>` framebuffer_format, :ref:`int<class_int>` vertex_format, :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` primitive, :ref:`RDPipelineRasterizationState<class_RDPipelineRasterizationState>` rasterization_state, :ref:`RDPipelineMultisampleState<class_RDPipelineMultisampleState>` multisample_state, :ref:`RDPipelineDepthStencilState<class_RDPipelineDepthStencilState>` stencil_state, :ref:`RDPipelineColorBlendState<class_RDPipelineColorBlendState>` color_blend_state, |bitfield|\<:ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>`\> dynamic_state_flags=0, :ref:`int<class_int>` for_render_pass=0, :ref:`RDPipelineSpecializationConstant[]<class_RDPipelineSpecializationConstant>` specialization_constants=[] **)** |
  146. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | :ref:`bool<class_bool>` | :ref:`render_pipeline_is_valid<class_RenderingDevice_method_render_pipeline_is_valid>` **(** :ref:`RID<class_RID>` render_pipeline **)** |
  148. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | :ref:`RID<class_RID>` | :ref:`sampler_create<class_RenderingDevice_method_sampler_create>` **(** :ref:`RDSamplerState<class_RDSamplerState>` state **)** |
  150. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | :ref:`bool<class_bool>` | :ref:`sampler_is_format_supported_for_filter<class_RenderingDevice_method_sampler_is_format_supported_for_filter>` **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>` sampler_filter **)** |const| |
  152. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | :ref:`int<class_int>` | :ref:`screen_get_framebuffer_format<class_RenderingDevice_method_screen_get_framebuffer_format>` **(** **)** |const| |
  154. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | :ref:`int<class_int>` | :ref:`screen_get_height<class_RenderingDevice_method_screen_get_height>` **(** :ref:`int<class_int>` screen=0 **)** |const| |
  156. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | :ref:`int<class_int>` | :ref:`screen_get_width<class_RenderingDevice_method_screen_get_width>` **(** :ref:`int<class_int>` screen=0 **)** |const| |
  158. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | void | :ref:`set_resource_name<class_RenderingDevice_method_set_resource_name>` **(** :ref:`RID<class_RID>` id, :ref:`String<class_String>` name **)** |
  160. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`shader_compile_binary_from_spirv<class_RenderingDevice_method_shader_compile_binary_from_spirv>` **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)** |
  162. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` | :ref:`shader_compile_spirv_from_source<class_RenderingDevice_method_shader_compile_spirv_from_source>` **(** :ref:`RDShaderSource<class_RDShaderSource>` shader_source, :ref:`bool<class_bool>` allow_cache=true **)** |
  164. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :ref:`RID<class_RID>` | :ref:`shader_create_from_bytecode<class_RenderingDevice_method_shader_create_from_bytecode>` **(** :ref:`PackedByteArray<class_PackedByteArray>` binary_data, :ref:`RID<class_RID>` placeholder_rid=RID() **)** |
  166. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :ref:`RID<class_RID>` | :ref:`shader_create_from_spirv<class_RenderingDevice_method_shader_create_from_spirv>` **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)** |
  168. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | :ref:`RID<class_RID>` | :ref:`shader_create_placeholder<class_RenderingDevice_method_shader_create_placeholder>` **(** **)** |
  170. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | :ref:`int<class_int>` | :ref:`shader_get_vertex_input_attribute_mask<class_RenderingDevice_method_shader_get_vertex_input_attribute_mask>` **(** :ref:`RID<class_RID>` shader **)** |
  172. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | :ref:`RID<class_RID>` | :ref:`storage_buffer_create<class_RenderingDevice_method_storage_buffer_create>` **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), |bitfield|\<:ref:`StorageBufferUsage<enum_RenderingDevice_StorageBufferUsage>`\> usage=0 **)** |
  174. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | void | :ref:`submit<class_RenderingDevice_method_submit>` **(** **)** |
  176. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | void | :ref:`sync<class_RenderingDevice_method_sync>` **(** **)** |
  178. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | :ref:`RID<class_RID>` | :ref:`texture_buffer_create<class_RenderingDevice_method_texture_buffer_create>` **(** :ref:`int<class_int>` size_bytes, :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray() **)** |
  180. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_clear<class_RenderingDevice_method_texture_clear>` **(** :ref:`RID<class_RID>` texture, :ref:`Color<class_Color>` color, :ref:`int<class_int>` base_mipmap, :ref:`int<class_int>` mipmap_count, :ref:`int<class_int>` base_layer, :ref:`int<class_int>` layer_count, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)** |
  182. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_copy<class_RenderingDevice_method_texture_copy>` **(** :ref:`RID<class_RID>` from_texture, :ref:`RID<class_RID>` to_texture, :ref:`Vector3<class_Vector3>` from_pos, :ref:`Vector3<class_Vector3>` to_pos, :ref:`Vector3<class_Vector3>` size, :ref:`int<class_int>` src_mipmap, :ref:`int<class_int>` dst_mipmap, :ref:`int<class_int>` src_layer, :ref:`int<class_int>` dst_layer, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)** |
  184. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | :ref:`RID<class_RID>` | :ref:`texture_create<class_RenderingDevice_method_texture_create>` **(** :ref:`RDTextureFormat<class_RDTextureFormat>` format, :ref:`RDTextureView<class_RDTextureView>` view, :ref:`PackedByteArray[]<class_PackedByteArray>` data=[] **)** |
  186. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :ref:`RID<class_RID>` | :ref:`texture_create_from_extension<class_RenderingDevice_method_texture_create_from_extension>` **(** :ref:`TextureType<enum_RenderingDevice_TextureType>` type, :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples, |bitfield|\<:ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>`\> usage_flags, :ref:`int<class_int>` image, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`int<class_int>` layers **)** |
  188. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | :ref:`RID<class_RID>` | :ref:`texture_create_shared<class_RenderingDevice_method_texture_create_shared>` **(** :ref:`RDTextureView<class_RDTextureView>` view, :ref:`RID<class_RID>` with_texture **)** |
  190. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`RID<class_RID>` | :ref:`texture_create_shared_from_slice<class_RenderingDevice_method_texture_create_shared_from_slice>` **(** :ref:`RDTextureView<class_RDTextureView>` view, :ref:`RID<class_RID>` with_texture, :ref:`int<class_int>` layer, :ref:`int<class_int>` mipmap, :ref:`int<class_int>` mipmaps=1, :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` slice_type=0 **)** |
  192. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`texture_get_data<class_RenderingDevice_method_texture_get_data>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |
  194. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | :ref:`RDTextureFormat<class_RDTextureFormat>` | :ref:`texture_get_format<class_RenderingDevice_method_texture_get_format>` **(** :ref:`RID<class_RID>` texture **)** |
  196. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :ref:`int<class_int>` | :ref:`texture_get_native_handle<class_RenderingDevice_method_texture_get_native_handle>` **(** :ref:`RID<class_RID>` texture **)** |
  198. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | :ref:`bool<class_bool>` | :ref:`texture_is_format_supported_for_usage<class_RenderingDevice_method_texture_is_format_supported_for_usage>` **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, |bitfield|\<:ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>`\> usage_flags **)** |const| |
  200. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | :ref:`bool<class_bool>` | :ref:`texture_is_shared<class_RenderingDevice_method_texture_is_shared>` **(** :ref:`RID<class_RID>` texture **)** |
  202. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :ref:`bool<class_bool>` | :ref:`texture_is_valid<class_RenderingDevice_method_texture_is_valid>` **(** :ref:`RID<class_RID>` texture **)** |
  204. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_resolve_multisample<class_RenderingDevice_method_texture_resolve_multisample>` **(** :ref:`RID<class_RID>` from_texture, :ref:`RID<class_RID>` to_texture, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)** |
  206. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_update<class_RenderingDevice_method_texture_update>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer, :ref:`PackedByteArray<class_PackedByteArray>` data, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)** |
  208. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | :ref:`RID<class_RID>` | :ref:`uniform_buffer_create<class_RenderingDevice_method_uniform_buffer_create>` **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray() **)** |
  210. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | :ref:`RID<class_RID>` | :ref:`uniform_set_create<class_RenderingDevice_method_uniform_set_create>` **(** :ref:`RDUniform[]<class_RDUniform>` uniforms, :ref:`RID<class_RID>` shader, :ref:`int<class_int>` shader_set **)** |
  212. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | :ref:`bool<class_bool>` | :ref:`uniform_set_is_valid<class_RenderingDevice_method_uniform_set_is_valid>` **(** :ref:`RID<class_RID>` uniform_set **)** |
  214. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | :ref:`RID<class_RID>` | :ref:`vertex_array_create<class_RenderingDevice_method_vertex_array_create>` **(** :ref:`int<class_int>` vertex_count, :ref:`int<class_int>` vertex_format, :ref:`RID[]<class_RID>` src_buffers, :ref:`PackedInt64Array<class_PackedInt64Array>` offsets=PackedInt64Array() **)** |
  216. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | :ref:`RID<class_RID>` | :ref:`vertex_buffer_create<class_RenderingDevice_method_vertex_buffer_create>` **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`bool<class_bool>` use_as_storage=false **)** |
  218. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | :ref:`int<class_int>` | :ref:`vertex_format_create<class_RenderingDevice_method_vertex_format_create>` **(** :ref:`RDVertexAttribute[]<class_RDVertexAttribute>` vertex_descriptions **)** |
  220. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. .. rst-class:: classref-section-separator
  222. ----
  223. .. rst-class:: classref-descriptions-group
  224. Enumerations
  225. ------------
  226. .. _enum_RenderingDevice_DeviceType:
  227. .. rst-class:: classref-enumeration
  228. enum **DeviceType**:
  229. .. _class_RenderingDevice_constant_DEVICE_TYPE_OTHER:
  230. .. rst-class:: classref-enumeration-constant
  231. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_OTHER** = ``0``
  232. Rendering device type does not match any of the other enum values or is unknown.
  233. .. _class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU:
  234. .. rst-class:: classref-enumeration-constant
  235. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_INTEGRATED_GPU** = ``1``
  236. 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>`.
  237. .. _class_RenderingDevice_constant_DEVICE_TYPE_DISCRETE_GPU:
  238. .. rst-class:: classref-enumeration-constant
  239. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_DISCRETE_GPU** = ``2``
  240. 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>`).
  241. .. _class_RenderingDevice_constant_DEVICE_TYPE_VIRTUAL_GPU:
  242. .. rst-class:: classref-enumeration-constant
  243. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_VIRTUAL_GPU** = ``3``
  244. 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.
  245. .. _class_RenderingDevice_constant_DEVICE_TYPE_CPU:
  246. .. rst-class:: classref-enumeration-constant
  247. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_CPU** = ``4``
  248. 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>`.
  249. .. _class_RenderingDevice_constant_DEVICE_TYPE_MAX:
  250. .. rst-class:: classref-enumeration-constant
  251. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_MAX** = ``5``
  252. Represents the size of the :ref:`DeviceType<enum_RenderingDevice_DeviceType>` enum.
  253. .. rst-class:: classref-item-separator
  254. ----
  255. .. _enum_RenderingDevice_DriverResource:
  256. .. rst-class:: classref-enumeration
  257. enum **DriverResource**:
  258. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DEVICE:
  259. .. rst-class:: classref-enumeration-constant
  260. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_DEVICE** = ``0``
  261. Vulkan device driver resource. This is a "global" resource and ignores the RID passed in
  262. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE:
  263. .. rst-class:: classref-enumeration-constant
  264. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE** = ``1``
  265. Physical device (graphics card) driver resource.
  266. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_INSTANCE:
  267. .. rst-class:: classref-enumeration-constant
  268. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_INSTANCE** = ``2``
  269. Vulkan instance driver resource.
  270. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE:
  271. .. rst-class:: classref-enumeration-constant
  272. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_QUEUE** = ``3``
  273. Vulkan queue driver resource.
  274. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX:
  275. .. rst-class:: classref-enumeration-constant
  276. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX** = ``4``
  277. Vulkan queue family index driver resource.
  278. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE:
  279. .. rst-class:: classref-enumeration-constant
  280. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_IMAGE** = ``5``
  281. Vulkan image driver resource.
  282. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_VIEW:
  283. .. rst-class:: classref-enumeration-constant
  284. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_IMAGE_VIEW** = ``6``
  285. Vulkan image view driver resource.
  286. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT:
  287. .. rst-class:: classref-enumeration-constant
  288. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT** = ``7``
  289. Vulkan image native texture format driver resource.
  290. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_SAMPLER:
  291. .. rst-class:: classref-enumeration-constant
  292. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_SAMPLER** = ``8``
  293. Vulkan sampler driver resource.
  294. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET:
  295. .. rst-class:: classref-enumeration-constant
  296. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET** = ``9``
  297. Vulkan `descriptor set <https://vkguide.dev/docs/chapter-4/descriptors/>`__ driver resource.
  298. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_BUFFER:
  299. .. rst-class:: classref-enumeration-constant
  300. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_BUFFER** = ``10``
  301. Vulkan buffer driver resource.
  302. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE:
  303. .. rst-class:: classref-enumeration-constant
  304. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE** = ``11``
  305. Vulkan compute pipeline driver resource.
  306. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE:
  307. .. rst-class:: classref-enumeration-constant
  308. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE** = ``12``
  309. Vulkan render pipeline driver resource.
  310. .. rst-class:: classref-item-separator
  311. ----
  312. .. _enum_RenderingDevice_DataFormat:
  313. .. rst-class:: classref-enumeration
  314. enum **DataFormat**:
  315. .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4_UNORM_PACK8:
  316. .. rst-class:: classref-enumeration-constant
  317. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R4G4_UNORM_PACK8** = ``0``
  318. 4-bit-per-channel red/green channel data format, packed into 8 bits. Values are in the ``[0.0, 1.0]`` range.
  319. \ **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.
  320. .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4B4A4_UNORM_PACK16:
  321. .. rst-class:: classref-enumeration-constant
  322. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R4G4B4A4_UNORM_PACK16** = ``1``
  323. 4-bit-per-channel red/green/blue/alpha channel data format, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  324. .. _class_RenderingDevice_constant_DATA_FORMAT_B4G4R4A4_UNORM_PACK16:
  325. .. rst-class:: classref-enumeration-constant
  326. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B4G4R4A4_UNORM_PACK16** = ``2``
  327. 4-bit-per-channel blue/green/red/alpha channel data format, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  328. .. _class_RenderingDevice_constant_DATA_FORMAT_R5G6B5_UNORM_PACK16:
  329. .. rst-class:: classref-enumeration-constant
  330. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R5G6B5_UNORM_PACK16** = ``3``
  331. 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.
  332. .. _class_RenderingDevice_constant_DATA_FORMAT_B5G6R5_UNORM_PACK16:
  333. .. rst-class:: classref-enumeration-constant
  334. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B5G6R5_UNORM_PACK16** = ``4``
  335. 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.
  336. .. _class_RenderingDevice_constant_DATA_FORMAT_R5G5B5A1_UNORM_PACK16:
  337. .. rst-class:: classref-enumeration-constant
  338. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R5G5B5A1_UNORM_PACK16** = ``5``
  339. 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.
  340. .. _class_RenderingDevice_constant_DATA_FORMAT_B5G5R5A1_UNORM_PACK16:
  341. .. rst-class:: classref-enumeration-constant
  342. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B5G5R5A1_UNORM_PACK16** = ``6``
  343. 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.
  344. .. _class_RenderingDevice_constant_DATA_FORMAT_A1R5G5B5_UNORM_PACK16:
  345. .. rst-class:: classref-enumeration-constant
  346. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A1R5G5B5_UNORM_PACK16** = ``7``
  347. 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.
  348. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UNORM:
  349. .. rst-class:: classref-enumeration-constant
  350. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_UNORM** = ``8``
  351. 8-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  352. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SNORM:
  353. .. rst-class:: classref-enumeration-constant
  354. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SNORM** = ``9``
  355. 8-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  356. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_USCALED:
  357. .. rst-class:: classref-enumeration-constant
  358. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_USCALED** = ``10``
  359. 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.
  360. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SSCALED:
  361. .. rst-class:: classref-enumeration-constant
  362. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SSCALED** = ``11``
  363. 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.
  364. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UINT:
  365. .. rst-class:: classref-enumeration-constant
  366. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_UINT** = ``12``
  367. 8-bit-per-channel unsigned integer red channel data format. Values are in the ``[0, 255]`` range.
  368. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SINT:
  369. .. rst-class:: classref-enumeration-constant
  370. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SINT** = ``13``
  371. 8-bit-per-channel signed integer red channel data format. Values are in the ``[-127, 127]`` range.
  372. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SRGB:
  373. .. rst-class:: classref-enumeration-constant
  374. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SRGB** = ``14``
  375. 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.
  376. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UNORM:
  377. .. rst-class:: classref-enumeration-constant
  378. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_UNORM** = ``15``
  379. 8-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  380. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SNORM:
  381. .. rst-class:: classref-enumeration-constant
  382. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SNORM** = ``16``
  383. 8-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  384. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_USCALED:
  385. .. rst-class:: classref-enumeration-constant
  386. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_USCALED** = ``17``
  387. 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.
  388. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SSCALED:
  389. .. rst-class:: classref-enumeration-constant
  390. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SSCALED** = ``18``
  391. 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.
  392. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UINT:
  393. .. rst-class:: classref-enumeration-constant
  394. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_UINT** = ``19``
  395. 8-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0, 255]`` range.
  396. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SINT:
  397. .. rst-class:: classref-enumeration-constant
  398. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SINT** = ``20``
  399. 8-bit-per-channel signed integer red/green channel data format. Values are in the ``[-127, 127]`` range.
  400. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SRGB:
  401. .. rst-class:: classref-enumeration-constant
  402. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SRGB** = ``21``
  403. 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.
  404. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UNORM:
  405. .. rst-class:: classref-enumeration-constant
  406. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_UNORM** = ``22``
  407. 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.
  408. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SNORM:
  409. .. rst-class:: classref-enumeration-constant
  410. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SNORM** = ``23``
  411. 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.
  412. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_USCALED:
  413. .. rst-class:: classref-enumeration-constant
  414. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_USCALED** = ``24``
  415. 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.
  416. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SSCALED:
  417. .. rst-class:: classref-enumeration-constant
  418. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SSCALED** = ``25``
  419. 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.
  420. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UINT:
  421. .. rst-class:: classref-enumeration-constant
  422. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_UINT** = ``26``
  423. 8-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0, 255]`` range.
  424. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SINT:
  425. .. rst-class:: classref-enumeration-constant
  426. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SINT** = ``27``
  427. 8-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[-127, 127]`` range.
  428. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SRGB:
  429. .. rst-class:: classref-enumeration-constant
  430. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SRGB** = ``28``
  431. 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.
  432. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UNORM:
  433. .. rst-class:: classref-enumeration-constant
  434. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_UNORM** = ``29``
  435. 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.
  436. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SNORM:
  437. .. rst-class:: classref-enumeration-constant
  438. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SNORM** = ``30``
  439. 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.
  440. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_USCALED:
  441. .. rst-class:: classref-enumeration-constant
  442. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_USCALED** = ``31``
  443. 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.
  444. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SSCALED:
  445. .. rst-class:: classref-enumeration-constant
  446. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SSCALED** = ``32``
  447. 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.
  448. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UINT:
  449. .. rst-class:: classref-enumeration-constant
  450. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_UINT** = ``33``
  451. 8-bit-per-channel unsigned integer blue/green/red channel data format. Values are in the ``[0, 255]`` range.
  452. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SINT:
  453. .. rst-class:: classref-enumeration-constant
  454. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SINT** = ``34``
  455. 8-bit-per-channel signed integer blue/green/red channel data format. Values are in the ``[-127, 127]`` range.
  456. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SRGB:
  457. .. rst-class:: classref-enumeration-constant
  458. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SRGB** = ``35``
  459. 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.
  460. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UNORM:
  461. .. rst-class:: classref-enumeration-constant
  462. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_UNORM** = ``36``
  463. 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.
  464. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SNORM:
  465. .. rst-class:: classref-enumeration-constant
  466. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SNORM** = ``37``
  467. 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.
  468. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_USCALED:
  469. .. rst-class:: classref-enumeration-constant
  470. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_USCALED** = ``38``
  471. 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.
  472. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SSCALED:
  473. .. rst-class:: classref-enumeration-constant
  474. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SSCALED** = ``39``
  475. 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.
  476. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UINT:
  477. .. rst-class:: classref-enumeration-constant
  478. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_UINT** = ``40``
  479. 8-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0, 255]`` range.
  480. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SINT:
  481. .. rst-class:: classref-enumeration-constant
  482. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SINT** = ``41``
  483. 8-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[-127, 127]`` range.
  484. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SRGB:
  485. .. rst-class:: classref-enumeration-constant
  486. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SRGB** = ``42``
  487. 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.
  488. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UNORM:
  489. .. rst-class:: classref-enumeration-constant
  490. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_UNORM** = ``43``
  491. 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.
  492. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SNORM:
  493. .. rst-class:: classref-enumeration-constant
  494. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SNORM** = ``44``
  495. 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.
  496. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_USCALED:
  497. .. rst-class:: classref-enumeration-constant
  498. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_USCALED** = ``45``
  499. 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.
  500. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SSCALED:
  501. .. rst-class:: classref-enumeration-constant
  502. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SSCALED** = ``46``
  503. 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.
  504. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UINT:
  505. .. rst-class:: classref-enumeration-constant
  506. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_UINT** = ``47``
  507. 8-bit-per-channel unsigned integer blue/green/red/alpha channel data format. Values are in the ``[0, 255]`` range.
  508. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SINT:
  509. .. rst-class:: classref-enumeration-constant
  510. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SINT** = ``48``
  511. 8-bit-per-channel signed integer blue/green/red/alpha channel data format. Values are in the ``[-127, 127]`` range.
  512. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SRGB:
  513. .. rst-class:: classref-enumeration-constant
  514. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SRGB** = ``49``
  515. 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.
  516. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UNORM_PACK32:
  517. .. rst-class:: classref-enumeration-constant
  518. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_UNORM_PACK32** = ``50``
  519. 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.
  520. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SNORM_PACK32:
  521. .. rst-class:: classref-enumeration-constant
  522. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SNORM_PACK32** = ``51``
  523. 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.
  524. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_USCALED_PACK32:
  525. .. rst-class:: classref-enumeration-constant
  526. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_USCALED_PACK32** = ``52``
  527. 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.
  528. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SSCALED_PACK32:
  529. .. rst-class:: classref-enumeration-constant
  530. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SSCALED_PACK32** = ``53``
  531. 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.
  532. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UINT_PACK32:
  533. .. rst-class:: classref-enumeration-constant
  534. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_UINT_PACK32** = ``54``
  535. 8-bit-per-channel unsigned integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the ``[0, 255]`` range.
  536. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SINT_PACK32:
  537. .. rst-class:: classref-enumeration-constant
  538. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SINT_PACK32** = ``55``
  539. 8-bit-per-channel signed integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the ``[-127, 127]`` range.
  540. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SRGB_PACK32:
  541. .. rst-class:: classref-enumeration-constant
  542. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SRGB_PACK32** = ``56``
  543. 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.
  544. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UNORM_PACK32:
  545. .. rst-class:: classref-enumeration-constant
  546. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_UNORM_PACK32** = ``57``
  547. 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.
  548. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SNORM_PACK32:
  549. .. rst-class:: classref-enumeration-constant
  550. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_SNORM_PACK32** = ``58``
  551. 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.
  552. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_USCALED_PACK32:
  553. .. rst-class:: classref-enumeration-constant
  554. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_USCALED_PACK32** = ``59``
  555. 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.
  556. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SSCALED_PACK32:
  557. .. rst-class:: classref-enumeration-constant
  558. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_SSCALED_PACK32** = ``60``
  559. 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.
  560. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UINT_PACK32:
  561. .. rst-class:: classref-enumeration-constant
  562. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_UINT_PACK32** = ``61``
  563. 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.
  564. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SINT_PACK32:
  565. .. rst-class:: classref-enumeration-constant
  566. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_SINT_PACK32** = ``62``
  567. 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.
  568. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UNORM_PACK32:
  569. .. rst-class:: classref-enumeration-constant
  570. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_UNORM_PACK32** = ``63``
  571. 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.
  572. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SNORM_PACK32:
  573. .. rst-class:: classref-enumeration-constant
  574. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_SNORM_PACK32** = ``64``
  575. 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.
  576. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_USCALED_PACK32:
  577. .. rst-class:: classref-enumeration-constant
  578. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_USCALED_PACK32** = ``65``
  579. 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.
  580. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SSCALED_PACK32:
  581. .. rst-class:: classref-enumeration-constant
  582. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_SSCALED_PACK32** = ``66``
  583. 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.
  584. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UINT_PACK32:
  585. .. rst-class:: classref-enumeration-constant
  586. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_UINT_PACK32** = ``67``
  587. 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.
  588. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SINT_PACK32:
  589. .. rst-class:: classref-enumeration-constant
  590. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_SINT_PACK32** = ``68``
  591. 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.
  592. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UNORM:
  593. .. rst-class:: classref-enumeration-constant
  594. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_UNORM** = ``69``
  595. 16-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  596. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SNORM:
  597. .. rst-class:: classref-enumeration-constant
  598. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SNORM** = ``70``
  599. 16-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  600. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_USCALED:
  601. .. rst-class:: classref-enumeration-constant
  602. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_USCALED** = ``71``
  603. 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.
  604. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SSCALED:
  605. .. rst-class:: classref-enumeration-constant
  606. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SSCALED** = ``72``
  607. 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.
  608. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UINT:
  609. .. rst-class:: classref-enumeration-constant
  610. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_UINT** = ``73``
  611. 16-bit-per-channel unsigned integer red channel data format. Values are in the ``[0.0, 65535]`` range.
  612. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SINT:
  613. .. rst-class:: classref-enumeration-constant
  614. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SINT** = ``74``
  615. 16-bit-per-channel signed integer red channel data format. Values are in the ``[-32767, 32767]`` range.
  616. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SFLOAT:
  617. .. rst-class:: classref-enumeration-constant
  618. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SFLOAT** = ``75``
  619. 16-bit-per-channel signed floating-point red channel data format with the value stored as-is.
  620. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UNORM:
  621. .. rst-class:: classref-enumeration-constant
  622. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_UNORM** = ``76``
  623. 16-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  624. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SNORM:
  625. .. rst-class:: classref-enumeration-constant
  626. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SNORM** = ``77``
  627. 16-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  628. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_USCALED:
  629. .. rst-class:: classref-enumeration-constant
  630. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_USCALED** = ``78``
  631. 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.
  632. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SSCALED:
  633. .. rst-class:: classref-enumeration-constant
  634. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SSCALED** = ``79``
  635. 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.
  636. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UINT:
  637. .. rst-class:: classref-enumeration-constant
  638. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_UINT** = ``80``
  639. 16-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0.0, 65535]`` range.
  640. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SINT:
  641. .. rst-class:: classref-enumeration-constant
  642. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SINT** = ``81``
  643. 16-bit-per-channel signed integer red/green channel data format. Values are in the ``[-32767, 32767]`` range.
  644. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SFLOAT:
  645. .. rst-class:: classref-enumeration-constant
  646. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SFLOAT** = ``82``
  647. 16-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
  648. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UNORM:
  649. .. rst-class:: classref-enumeration-constant
  650. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_UNORM** = ``83``
  651. 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.
  652. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SNORM:
  653. .. rst-class:: classref-enumeration-constant
  654. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SNORM** = ``84``
  655. 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.
  656. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_USCALED:
  657. .. rst-class:: classref-enumeration-constant
  658. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_USCALED** = ``85``
  659. 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.
  660. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SSCALED:
  661. .. rst-class:: classref-enumeration-constant
  662. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SSCALED** = ``86``
  663. 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.
  664. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UINT:
  665. .. rst-class:: classref-enumeration-constant
  666. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_UINT** = ``87``
  667. 16-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0.0, 65535]`` range.
  668. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SINT:
  669. .. rst-class:: classref-enumeration-constant
  670. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SINT** = ``88``
  671. 16-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[-32767, 32767]`` range.
  672. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SFLOAT:
  673. .. rst-class:: classref-enumeration-constant
  674. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SFLOAT** = ``89``
  675. 16-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
  676. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UNORM:
  677. .. rst-class:: classref-enumeration-constant
  678. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_UNORM** = ``90``
  679. 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.
  680. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SNORM:
  681. .. rst-class:: classref-enumeration-constant
  682. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SNORM** = ``91``
  683. 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.
  684. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_USCALED:
  685. .. rst-class:: classref-enumeration-constant
  686. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_USCALED** = ``92``
  687. 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.
  688. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SSCALED:
  689. .. rst-class:: classref-enumeration-constant
  690. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SSCALED** = ``93``
  691. 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.
  692. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UINT:
  693. .. rst-class:: classref-enumeration-constant
  694. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_UINT** = ``94``
  695. 16-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0.0, 65535]`` range.
  696. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SINT:
  697. .. rst-class:: classref-enumeration-constant
  698. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SINT** = ``95``
  699. 16-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[-32767, 32767]`` range.
  700. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SFLOAT:
  701. .. rst-class:: classref-enumeration-constant
  702. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SFLOAT** = ``96``
  703. 16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
  704. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_UINT:
  705. .. rst-class:: classref-enumeration-constant
  706. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32_UINT** = ``97``
  707. 32-bit-per-channel unsigned integer red channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  708. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SINT:
  709. .. rst-class:: classref-enumeration-constant
  710. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32_SINT** = ``98``
  711. 32-bit-per-channel signed integer red channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  712. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SFLOAT:
  713. .. rst-class:: classref-enumeration-constant
  714. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32_SFLOAT** = ``99``
  715. 32-bit-per-channel signed floating-point red channel data format with the value stored as-is.
  716. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_UINT:
  717. .. rst-class:: classref-enumeration-constant
  718. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32_UINT** = ``100``
  719. 32-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  720. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SINT:
  721. .. rst-class:: classref-enumeration-constant
  722. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32_SINT** = ``101``
  723. 32-bit-per-channel signed integer red/green channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  724. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SFLOAT:
  725. .. rst-class:: classref-enumeration-constant
  726. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32_SFLOAT** = ``102``
  727. 32-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
  728. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_UINT:
  729. .. rst-class:: classref-enumeration-constant
  730. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32_UINT** = ``103``
  731. 32-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  732. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SINT:
  733. .. rst-class:: classref-enumeration-constant
  734. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32_SINT** = ``104``
  735. 32-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  736. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SFLOAT:
  737. .. rst-class:: classref-enumeration-constant
  738. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32_SFLOAT** = ``105``
  739. 32-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
  740. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_UINT:
  741. .. rst-class:: classref-enumeration-constant
  742. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32A32_UINT** = ``106``
  743. 32-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  744. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SINT:
  745. .. rst-class:: classref-enumeration-constant
  746. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32A32_SINT** = ``107``
  747. 32-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  748. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SFLOAT:
  749. .. rst-class:: classref-enumeration-constant
  750. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32A32_SFLOAT** = ``108``
  751. 32-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
  752. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_UINT:
  753. .. rst-class:: classref-enumeration-constant
  754. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64_UINT** = ``109``
  755. 64-bit-per-channel unsigned integer red channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  756. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SINT:
  757. .. rst-class:: classref-enumeration-constant
  758. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64_SINT** = ``110``
  759. 64-bit-per-channel signed integer red channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  760. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SFLOAT:
  761. .. rst-class:: classref-enumeration-constant
  762. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64_SFLOAT** = ``111``
  763. 64-bit-per-channel signed floating-point red channel data format with the value stored as-is.
  764. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_UINT:
  765. .. rst-class:: classref-enumeration-constant
  766. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64_UINT** = ``112``
  767. 64-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  768. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SINT:
  769. .. rst-class:: classref-enumeration-constant
  770. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64_SINT** = ``113``
  771. 64-bit-per-channel signed integer red/green channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  772. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SFLOAT:
  773. .. rst-class:: classref-enumeration-constant
  774. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64_SFLOAT** = ``114``
  775. 64-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
  776. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_UINT:
  777. .. rst-class:: classref-enumeration-constant
  778. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64_UINT** = ``115``
  779. 64-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  780. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SINT:
  781. .. rst-class:: classref-enumeration-constant
  782. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64_SINT** = ``116``
  783. 64-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  784. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SFLOAT:
  785. .. rst-class:: classref-enumeration-constant
  786. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64_SFLOAT** = ``117``
  787. 64-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
  788. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_UINT:
  789. .. rst-class:: classref-enumeration-constant
  790. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64A64_UINT** = ``118``
  791. 64-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  792. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SINT:
  793. .. rst-class:: classref-enumeration-constant
  794. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64A64_SINT** = ``119``
  795. 64-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  796. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SFLOAT:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64A64_SFLOAT** = ``120``
  799. 64-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
  800. .. _class_RenderingDevice_constant_DATA_FORMAT_B10G11R11_UFLOAT_PACK32:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B10G11R11_UFLOAT_PACK32** = ``121``
  803. 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.
  804. .. _class_RenderingDevice_constant_DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32:
  805. .. rst-class:: classref-enumeration-constant
  806. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32** = ``122``
  807. 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.
  808. .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM:
  809. .. rst-class:: classref-enumeration-constant
  810. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D16_UNORM** = ``123``
  811. 16-bit unsigned floating-point depth data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  812. .. _class_RenderingDevice_constant_DATA_FORMAT_X8_D24_UNORM_PACK32:
  813. .. rst-class:: classref-enumeration-constant
  814. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_X8_D24_UNORM_PACK32** = ``124``
  815. 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.
  816. .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT:
  817. .. rst-class:: classref-enumeration-constant
  818. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D32_SFLOAT** = ``125``
  819. 32-bit signed floating-point depth data format with the value stored as-is.
  820. .. _class_RenderingDevice_constant_DATA_FORMAT_S8_UINT:
  821. .. rst-class:: classref-enumeration-constant
  822. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_S8_UINT** = ``126``
  823. 8-bit unsigned integer stencil data format.
  824. .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM_S8_UINT:
  825. .. rst-class:: classref-enumeration-constant
  826. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D16_UNORM_S8_UINT** = ``127``
  827. 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.
  828. .. _class_RenderingDevice_constant_DATA_FORMAT_D24_UNORM_S8_UINT:
  829. .. rst-class:: classref-enumeration-constant
  830. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D24_UNORM_S8_UINT** = ``128``
  831. 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.
  832. .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT_S8_UINT:
  833. .. rst-class:: classref-enumeration-constant
  834. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D32_SFLOAT_S8_UINT** = ``129``
  835. 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.
  836. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_UNORM_BLOCK:
  837. .. rst-class:: classref-enumeration-constant
  838. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGB_UNORM_BLOCK** = ``130``
  839. 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).
  840. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_SRGB_BLOCK:
  841. .. rst-class:: classref-enumeration-constant
  842. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGB_SRGB_BLOCK** = ``131``
  843. 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).
  844. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_UNORM_BLOCK:
  845. .. rst-class:: classref-enumeration-constant
  846. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGBA_UNORM_BLOCK** = ``132``
  847. 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).
  848. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_SRGB_BLOCK:
  849. .. rst-class:: classref-enumeration-constant
  850. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGBA_SRGB_BLOCK** = ``133``
  851. 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).
  852. .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_UNORM_BLOCK:
  853. .. rst-class:: classref-enumeration-constant
  854. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC2_UNORM_BLOCK** = ``134``
  855. 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).
  856. .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_SRGB_BLOCK:
  857. .. rst-class:: classref-enumeration-constant
  858. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC2_SRGB_BLOCK** = ``135``
  859. 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).
  860. .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_UNORM_BLOCK:
  861. .. rst-class:: classref-enumeration-constant
  862. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC3_UNORM_BLOCK** = ``136``
  863. 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).
  864. .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_SRGB_BLOCK:
  865. .. rst-class:: classref-enumeration-constant
  866. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC3_SRGB_BLOCK** = ``137``
  867. 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).
  868. .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_UNORM_BLOCK:
  869. .. rst-class:: classref-enumeration-constant
  870. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC4_UNORM_BLOCK** = ``138``
  871. 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.
  872. .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_SNORM_BLOCK:
  873. .. rst-class:: classref-enumeration-constant
  874. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC4_SNORM_BLOCK** = ``139``
  875. 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.
  876. .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_UNORM_BLOCK:
  877. .. rst-class:: classref-enumeration-constant
  878. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC5_UNORM_BLOCK** = ``140``
  879. 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).
  880. .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_SNORM_BLOCK:
  881. .. rst-class:: classref-enumeration-constant
  882. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC5_SNORM_BLOCK** = ``141``
  883. 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).
  884. .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_UFLOAT_BLOCK:
  885. .. rst-class:: classref-enumeration-constant
  886. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC6H_UFLOAT_BLOCK** = ``142``
  887. VRAM-compressed unsigned red/green/blue channel data format with the floating-point value stored as-is. The format's precision is 8 bits of red channel and 8 bits of green channel. Using BC6H texture compression (also known as BPTC HDR).
  888. .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_SFLOAT_BLOCK:
  889. .. rst-class:: classref-enumeration-constant
  890. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC6H_SFLOAT_BLOCK** = ``143``
  891. VRAM-compressed signed red/green/blue channel data format with the floating-point value stored as-is. 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. Using BC7 texture compression (also known as BPTC HDR).
  892. .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_UNORM_BLOCK:
  893. .. rst-class:: classref-enumeration-constant
  894. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC7_UNORM_BLOCK** = ``144``
  895. 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.
  896. .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_SRGB_BLOCK:
  897. .. rst-class:: classref-enumeration-constant
  898. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC7_SRGB_BLOCK** = ``145``
  899. 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.
  900. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK:
  901. .. rst-class:: classref-enumeration-constant
  902. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK** = ``146``
  903. 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.
  904. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK:
  905. .. rst-class:: classref-enumeration-constant
  906. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK** = ``147``
  907. 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.
  908. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK:
  909. .. rst-class:: classref-enumeration-constant
  910. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK** = ``148``
  911. 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.
  912. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK:
  913. .. rst-class:: classref-enumeration-constant
  914. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK** = ``149``
  915. 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.
  916. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK:
  917. .. rst-class:: classref-enumeration-constant
  918. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK** = ``150``
  919. 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.
  920. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK:
  921. .. rst-class:: classref-enumeration-constant
  922. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK** = ``151``
  923. 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.
  924. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_UNORM_BLOCK:
  925. .. rst-class:: classref-enumeration-constant
  926. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11_UNORM_BLOCK** = ``152``
  927. 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.
  928. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_SNORM_BLOCK:
  929. .. rst-class:: classref-enumeration-constant
  930. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11_SNORM_BLOCK** = ``153``
  931. 11-bit VRAM-compressed signed red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Using ETC2 texture compression.
  932. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_UNORM_BLOCK:
  933. .. rst-class:: classref-enumeration-constant
  934. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11G11_UNORM_BLOCK** = ``154``
  935. 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.
  936. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_SNORM_BLOCK:
  937. .. rst-class:: classref-enumeration-constant
  938. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11G11_SNORM_BLOCK** = ``155``
  939. 11-bit VRAM-compressed signed red/green channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range. Using ETC2 texture compression.
  940. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_UNORM_BLOCK:
  941. .. rst-class:: classref-enumeration-constant
  942. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_4x4_UNORM_BLOCK** = ``156``
  943. 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.
  944. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_SRGB_BLOCK:
  945. .. rst-class:: classref-enumeration-constant
  946. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_4x4_SRGB_BLOCK** = ``157``
  947. 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.
  948. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_UNORM_BLOCK:
  949. .. rst-class:: classref-enumeration-constant
  950. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x4_UNORM_BLOCK** = ``158``
  951. 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.
  952. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_SRGB_BLOCK:
  953. .. rst-class:: classref-enumeration-constant
  954. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x4_SRGB_BLOCK** = ``159``
  955. 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.
  956. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_UNORM_BLOCK:
  957. .. rst-class:: classref-enumeration-constant
  958. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x5_UNORM_BLOCK** = ``160``
  959. 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.
  960. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_SRGB_BLOCK:
  961. .. rst-class:: classref-enumeration-constant
  962. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x5_SRGB_BLOCK** = ``161``
  963. 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.
  964. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_UNORM_BLOCK:
  965. .. rst-class:: classref-enumeration-constant
  966. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x5_UNORM_BLOCK** = ``162``
  967. 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.
  968. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_SRGB_BLOCK:
  969. .. rst-class:: classref-enumeration-constant
  970. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x5_SRGB_BLOCK** = ``163``
  971. 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.
  972. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_UNORM_BLOCK:
  973. .. rst-class:: classref-enumeration-constant
  974. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x6_UNORM_BLOCK** = ``164``
  975. 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.
  976. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_SRGB_BLOCK:
  977. .. rst-class:: classref-enumeration-constant
  978. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x6_SRGB_BLOCK** = ``165``
  979. 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.
  980. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_UNORM_BLOCK:
  981. .. rst-class:: classref-enumeration-constant
  982. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x5_UNORM_BLOCK** = ``166``
  983. 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.
  984. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_SRGB_BLOCK:
  985. .. rst-class:: classref-enumeration-constant
  986. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x5_SRGB_BLOCK** = ``167``
  987. 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.
  988. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_UNORM_BLOCK:
  989. .. rst-class:: classref-enumeration-constant
  990. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x6_UNORM_BLOCK** = ``168``
  991. 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.
  992. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_SRGB_BLOCK:
  993. .. rst-class:: classref-enumeration-constant
  994. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x6_SRGB_BLOCK** = ``169``
  995. 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.
  996. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_UNORM_BLOCK:
  997. .. rst-class:: classref-enumeration-constant
  998. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x8_UNORM_BLOCK** = ``170``
  999. 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.
  1000. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_SRGB_BLOCK:
  1001. .. rst-class:: classref-enumeration-constant
  1002. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x8_SRGB_BLOCK** = ``171``
  1003. 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.
  1004. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_UNORM_BLOCK:
  1005. .. rst-class:: classref-enumeration-constant
  1006. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x5_UNORM_BLOCK** = ``172``
  1007. 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.
  1008. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_SRGB_BLOCK:
  1009. .. rst-class:: classref-enumeration-constant
  1010. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x5_SRGB_BLOCK** = ``173``
  1011. 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.
  1012. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_UNORM_BLOCK:
  1013. .. rst-class:: classref-enumeration-constant
  1014. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x6_UNORM_BLOCK** = ``174``
  1015. 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.
  1016. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_SRGB_BLOCK:
  1017. .. rst-class:: classref-enumeration-constant
  1018. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x6_SRGB_BLOCK** = ``175``
  1019. 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.
  1020. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_UNORM_BLOCK:
  1021. .. rst-class:: classref-enumeration-constant
  1022. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x8_UNORM_BLOCK** = ``176``
  1023. 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.
  1024. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_SRGB_BLOCK:
  1025. .. rst-class:: classref-enumeration-constant
  1026. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x8_SRGB_BLOCK** = ``177``
  1027. 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.
  1028. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_UNORM_BLOCK:
  1029. .. rst-class:: classref-enumeration-constant
  1030. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x10_UNORM_BLOCK** = ``178``
  1031. 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.
  1032. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_SRGB_BLOCK:
  1033. .. rst-class:: classref-enumeration-constant
  1034. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x10_SRGB_BLOCK** = ``179``
  1035. 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.
  1036. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_UNORM_BLOCK:
  1037. .. rst-class:: classref-enumeration-constant
  1038. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x10_UNORM_BLOCK** = ``180``
  1039. 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.
  1040. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_SRGB_BLOCK:
  1041. .. rst-class:: classref-enumeration-constant
  1042. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x10_SRGB_BLOCK** = ``181``
  1043. 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.
  1044. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_UNORM_BLOCK:
  1045. .. rst-class:: classref-enumeration-constant
  1046. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x12_UNORM_BLOCK** = ``182``
  1047. 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.
  1048. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_SRGB_BLOCK:
  1049. .. rst-class:: classref-enumeration-constant
  1050. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x12_SRGB_BLOCK** = ``183``
  1051. 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.
  1052. .. _class_RenderingDevice_constant_DATA_FORMAT_G8B8G8R8_422_UNORM:
  1053. .. rst-class:: classref-enumeration-constant
  1054. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8B8G8R8_422_UNORM** = ``184``
  1055. 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).
  1056. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8G8_422_UNORM:
  1057. .. rst-class:: classref-enumeration-constant
  1058. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8G8_422_UNORM** = ``185``
  1059. 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).
  1060. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM:
  1061. .. rst-class:: classref-enumeration-constant
  1062. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM** = ``186``
  1063. 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).
  1064. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM:
  1065. .. rst-class:: classref-enumeration-constant
  1066. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM** = ``187``
  1067. 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).
  1068. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM:
  1069. .. rst-class:: classref-enumeration-constant
  1070. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM** = ``188``
  1071. 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).
  1072. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM:
  1073. .. rst-class:: classref-enumeration-constant
  1074. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM** = ``189``
  1075. 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).
  1076. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM:
  1077. .. rst-class:: classref-enumeration-constant
  1078. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM** = ``190``
  1079. 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.
  1080. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6_UNORM_PACK16:
  1081. .. rst-class:: classref-enumeration-constant
  1082. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R10X6_UNORM_PACK16** = ``191``
  1083. 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.
  1084. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6_UNORM_2PACK16:
  1085. .. rst-class:: classref-enumeration-constant
  1086. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R10X6G10X6_UNORM_2PACK16** = ``192``
  1087. 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.
  1088. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16:
  1089. .. rst-class:: classref-enumeration-constant
  1090. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16** = ``193``
  1091. 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.
  1092. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16:
  1093. .. rst-class:: classref-enumeration-constant
  1094. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16** = ``194``
  1095. 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.
  1096. .. _class_RenderingDevice_constant_DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16:
  1097. .. rst-class:: classref-enumeration-constant
  1098. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16** = ``195``
  1099. 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.
  1100. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16:
  1101. .. rst-class:: classref-enumeration-constant
  1102. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16** = ``196``
  1103. 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).
  1104. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16:
  1105. .. rst-class:: classref-enumeration-constant
  1106. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16** = ``197``
  1107. 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).
  1108. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16:
  1109. .. rst-class:: classref-enumeration-constant
  1110. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16** = ``198``
  1111. 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).
  1112. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16:
  1113. .. rst-class:: classref-enumeration-constant
  1114. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16** = ``199``
  1115. 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).
  1116. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16:
  1117. .. rst-class:: classref-enumeration-constant
  1118. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16** = ``200``
  1119. 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.
  1120. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4_UNORM_PACK16:
  1121. .. rst-class:: classref-enumeration-constant
  1122. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R12X4_UNORM_PACK16** = ``201``
  1123. 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.
  1124. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4_UNORM_2PACK16:
  1125. .. rst-class:: classref-enumeration-constant
  1126. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R12X4G12X4_UNORM_2PACK16** = ``202``
  1127. 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.
  1128. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16:
  1129. .. rst-class:: classref-enumeration-constant
  1130. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16** = ``203``
  1131. 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.
  1132. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16:
  1133. .. rst-class:: classref-enumeration-constant
  1134. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16** = ``204``
  1135. 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.
  1136. .. _class_RenderingDevice_constant_DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16:
  1137. .. rst-class:: classref-enumeration-constant
  1138. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16** = ``205``
  1139. 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.
  1140. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16:
  1141. .. rst-class:: classref-enumeration-constant
  1142. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16** = ``206``
  1143. 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).
  1144. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16:
  1145. .. rst-class:: classref-enumeration-constant
  1146. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16** = ``207``
  1147. 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).
  1148. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16:
  1149. .. rst-class:: classref-enumeration-constant
  1150. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16** = ``208``
  1151. 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).
  1152. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16:
  1153. .. rst-class:: classref-enumeration-constant
  1154. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16** = ``209``
  1155. 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).
  1156. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16:
  1157. .. rst-class:: classref-enumeration-constant
  1158. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16** = ``210``
  1159. 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.
  1160. .. _class_RenderingDevice_constant_DATA_FORMAT_G16B16G16R16_422_UNORM:
  1161. .. rst-class:: classref-enumeration-constant
  1162. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16B16G16R16_422_UNORM** = ``211``
  1163. 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).
  1164. .. _class_RenderingDevice_constant_DATA_FORMAT_B16G16R16G16_422_UNORM:
  1165. .. rst-class:: classref-enumeration-constant
  1166. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B16G16R16G16_422_UNORM** = ``212``
  1167. 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).
  1168. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM:
  1169. .. rst-class:: classref-enumeration-constant
  1170. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM** = ``213``
  1171. 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).
  1172. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM:
  1173. .. rst-class:: classref-enumeration-constant
  1174. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM** = ``214``
  1175. 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).
  1176. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM:
  1177. .. rst-class:: classref-enumeration-constant
  1178. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM** = ``215``
  1179. 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).
  1180. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM:
  1181. .. rst-class:: classref-enumeration-constant
  1182. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM** = ``216``
  1183. 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).
  1184. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM:
  1185. .. rst-class:: classref-enumeration-constant
  1186. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM** = ``217``
  1187. 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.
  1188. .. _class_RenderingDevice_constant_DATA_FORMAT_MAX:
  1189. .. rst-class:: classref-enumeration-constant
  1190. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_MAX** = ``218``
  1191. Represents the size of the :ref:`DataFormat<enum_RenderingDevice_DataFormat>` enum.
  1192. .. rst-class:: classref-item-separator
  1193. ----
  1194. .. _enum_RenderingDevice_BarrierMask:
  1195. .. rst-class:: classref-enumeration
  1196. flags **BarrierMask**:
  1197. .. _class_RenderingDevice_constant_BARRIER_MASK_VERTEX:
  1198. .. rst-class:: classref-enumeration-constant
  1199. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_VERTEX** = ``1``
  1200. Vertex shader barrier mask.
  1201. .. _class_RenderingDevice_constant_BARRIER_MASK_FRAGMENT:
  1202. .. rst-class:: classref-enumeration-constant
  1203. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_FRAGMENT** = ``8``
  1204. Fragment shader barrier mask.
  1205. .. _class_RenderingDevice_constant_BARRIER_MASK_COMPUTE:
  1206. .. rst-class:: classref-enumeration-constant
  1207. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_COMPUTE** = ``2``
  1208. Compute barrier mask.
  1209. .. _class_RenderingDevice_constant_BARRIER_MASK_TRANSFER:
  1210. .. rst-class:: classref-enumeration-constant
  1211. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_TRANSFER** = ``4``
  1212. Transfer barrier mask.
  1213. .. _class_RenderingDevice_constant_BARRIER_MASK_RASTER:
  1214. .. rst-class:: classref-enumeration-constant
  1215. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_RASTER** = ``9``
  1216. Raster barrier mask (vertex and fragment). Equivalent to ``BARRIER_MASK_VERTEX | BARRIER_MASK_FRAGMENT``.
  1217. .. _class_RenderingDevice_constant_BARRIER_MASK_ALL_BARRIERS:
  1218. .. rst-class:: classref-enumeration-constant
  1219. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_ALL_BARRIERS** = ``32767``
  1220. Barrier mask for all types (vertex, fragment, compute, transfer).
  1221. .. _class_RenderingDevice_constant_BARRIER_MASK_NO_BARRIER:
  1222. .. rst-class:: classref-enumeration-constant
  1223. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_NO_BARRIER** = ``32768``
  1224. No barrier for any type.
  1225. .. rst-class:: classref-item-separator
  1226. ----
  1227. .. _enum_RenderingDevice_TextureType:
  1228. .. rst-class:: classref-enumeration
  1229. enum **TextureType**:
  1230. .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D:
  1231. .. rst-class:: classref-enumeration-constant
  1232. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_1D** = ``0``
  1233. 1-dimensional texture.
  1234. .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D:
  1235. .. rst-class:: classref-enumeration-constant
  1236. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_2D** = ``1``
  1237. 2-dimensional texture.
  1238. .. _class_RenderingDevice_constant_TEXTURE_TYPE_3D:
  1239. .. rst-class:: classref-enumeration-constant
  1240. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_3D** = ``2``
  1241. 3-dimensional texture.
  1242. .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE:
  1243. .. rst-class:: classref-enumeration-constant
  1244. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_CUBE** = ``3``
  1245. :ref:`Cubemap<class_Cubemap>` texture.
  1246. .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D_ARRAY:
  1247. .. rst-class:: classref-enumeration-constant
  1248. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_1D_ARRAY** = ``4``
  1249. Array of 1-dimensional textures.
  1250. .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D_ARRAY:
  1251. .. rst-class:: classref-enumeration-constant
  1252. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_2D_ARRAY** = ``5``
  1253. Array of 2-dimensional textures.
  1254. .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE_ARRAY:
  1255. .. rst-class:: classref-enumeration-constant
  1256. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_CUBE_ARRAY** = ``6``
  1257. Array of :ref:`Cubemap<class_Cubemap>` textures.
  1258. .. _class_RenderingDevice_constant_TEXTURE_TYPE_MAX:
  1259. .. rst-class:: classref-enumeration-constant
  1260. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_MAX** = ``7``
  1261. Represents the size of the :ref:`TextureType<enum_RenderingDevice_TextureType>` enum.
  1262. .. rst-class:: classref-item-separator
  1263. ----
  1264. .. _enum_RenderingDevice_TextureSamples:
  1265. .. rst-class:: classref-enumeration
  1266. enum **TextureSamples**:
  1267. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_1:
  1268. .. rst-class:: classref-enumeration-constant
  1269. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_1** = ``0``
  1270. Perform 1 texture sample (this is the fastest but lowest-quality for antialiasing).
  1271. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_2:
  1272. .. rst-class:: classref-enumeration-constant
  1273. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_2** = ``1``
  1274. Perform 2 texture samples.
  1275. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_4:
  1276. .. rst-class:: classref-enumeration-constant
  1277. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_4** = ``2``
  1278. Perform 4 texture samples.
  1279. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_8:
  1280. .. rst-class:: classref-enumeration-constant
  1281. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_8** = ``3``
  1282. Perform 8 texture samples. Not supported on mobile GPUs (including Apple Silicon).
  1283. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_16:
  1284. .. rst-class:: classref-enumeration-constant
  1285. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_16** = ``4``
  1286. Perform 16 texture samples. Not supported on mobile GPUs and many desktop GPUs.
  1287. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_32:
  1288. .. rst-class:: classref-enumeration-constant
  1289. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_32** = ``5``
  1290. Perform 32 texture samples. Not supported on most GPUs.
  1291. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_64:
  1292. .. rst-class:: classref-enumeration-constant
  1293. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_64** = ``6``
  1294. Perform 64 texture samples (this is the slowest but highest-quality for antialiasing). Not supported on most GPUs.
  1295. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_MAX:
  1296. .. rst-class:: classref-enumeration-constant
  1297. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_MAX** = ``7``
  1298. Represents the size of the :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` enum.
  1299. .. rst-class:: classref-item-separator
  1300. ----
  1301. .. _enum_RenderingDevice_TextureUsageBits:
  1302. .. rst-class:: classref-enumeration
  1303. flags **TextureUsageBits**:
  1304. .. _class_RenderingDevice_constant_TEXTURE_USAGE_SAMPLING_BIT:
  1305. .. rst-class:: classref-enumeration-constant
  1306. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_SAMPLING_BIT** = ``1``
  1307. Texture can be sampled.
  1308. .. _class_RenderingDevice_constant_TEXTURE_USAGE_COLOR_ATTACHMENT_BIT:
  1309. .. rst-class:: classref-enumeration-constant
  1310. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_COLOR_ATTACHMENT_BIT** = ``2``
  1311. Texture can be used as a color attachment in a framebuffer.
  1312. .. _class_RenderingDevice_constant_TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT:
  1313. .. rst-class:: classref-enumeration-constant
  1314. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT** = ``4``
  1315. Texture can be used as a depth/stencil attachment in a framebuffer.
  1316. .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_BIT:
  1317. .. rst-class:: classref-enumeration-constant
  1318. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_STORAGE_BIT** = ``8``
  1319. Texture can be used as a `storage image <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#descriptorsets-storageimage>`__.
  1320. .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_ATOMIC_BIT:
  1321. .. rst-class:: classref-enumeration-constant
  1322. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_STORAGE_ATOMIC_BIT** = ``16``
  1323. 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.
  1324. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CPU_READ_BIT:
  1325. .. rst-class:: classref-enumeration-constant
  1326. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CPU_READ_BIT** = ``32``
  1327. 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.
  1328. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_UPDATE_BIT:
  1329. .. rst-class:: classref-enumeration-constant
  1330. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CAN_UPDATE_BIT** = ``64``
  1331. Texture can be updated using :ref:`texture_update<class_RenderingDevice_method_texture_update>`.
  1332. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT:
  1333. .. rst-class:: classref-enumeration-constant
  1334. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CAN_COPY_FROM_BIT** = ``128``
  1335. Texture can be a source for :ref:`texture_copy<class_RenderingDevice_method_texture_copy>`.
  1336. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_TO_BIT:
  1337. .. rst-class:: classref-enumeration-constant
  1338. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CAN_COPY_TO_BIT** = ``256``
  1339. Texture can be a destination for :ref:`texture_copy<class_RenderingDevice_method_texture_copy>`.
  1340. .. _class_RenderingDevice_constant_TEXTURE_USAGE_INPUT_ATTACHMENT_BIT:
  1341. .. rst-class:: classref-enumeration-constant
  1342. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_INPUT_ATTACHMENT_BIT** = ``512``
  1343. 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.
  1344. .. rst-class:: classref-item-separator
  1345. ----
  1346. .. _enum_RenderingDevice_TextureSwizzle:
  1347. .. rst-class:: classref-enumeration
  1348. enum **TextureSwizzle**:
  1349. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_IDENTITY:
  1350. .. rst-class:: classref-enumeration-constant
  1351. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_IDENTITY** = ``0``
  1352. Return the sampled value as-is.
  1353. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ZERO:
  1354. .. rst-class:: classref-enumeration-constant
  1355. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_ZERO** = ``1``
  1356. Always return ``0.0`` when sampling.
  1357. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ONE:
  1358. .. rst-class:: classref-enumeration-constant
  1359. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_ONE** = ``2``
  1360. Always return ``1.0`` when sampling.
  1361. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_R:
  1362. .. rst-class:: classref-enumeration-constant
  1363. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_R** = ``3``
  1364. Sample the red color channel.
  1365. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_G:
  1366. .. rst-class:: classref-enumeration-constant
  1367. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_G** = ``4``
  1368. Sample the green color channel.
  1369. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_B:
  1370. .. rst-class:: classref-enumeration-constant
  1371. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_B** = ``5``
  1372. Sample the blue color channel.
  1373. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_A:
  1374. .. rst-class:: classref-enumeration-constant
  1375. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_A** = ``6``
  1376. Sample the alpha channel.
  1377. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_MAX:
  1378. .. rst-class:: classref-enumeration-constant
  1379. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_MAX** = ``7``
  1380. Represents the size of the :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` enum.
  1381. .. rst-class:: classref-item-separator
  1382. ----
  1383. .. _enum_RenderingDevice_TextureSliceType:
  1384. .. rst-class:: classref-enumeration
  1385. enum **TextureSliceType**:
  1386. .. _class_RenderingDevice_constant_TEXTURE_SLICE_2D:
  1387. .. rst-class:: classref-enumeration-constant
  1388. :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` **TEXTURE_SLICE_2D** = ``0``
  1389. 2-dimensional texture slice.
  1390. .. _class_RenderingDevice_constant_TEXTURE_SLICE_CUBEMAP:
  1391. .. rst-class:: classref-enumeration-constant
  1392. :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` **TEXTURE_SLICE_CUBEMAP** = ``1``
  1393. Cubemap texture slice.
  1394. .. _class_RenderingDevice_constant_TEXTURE_SLICE_3D:
  1395. .. rst-class:: classref-enumeration-constant
  1396. :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` **TEXTURE_SLICE_3D** = ``2``
  1397. 3-dimensional texture slice.
  1398. .. rst-class:: classref-item-separator
  1399. ----
  1400. .. _enum_RenderingDevice_SamplerFilter:
  1401. .. rst-class:: classref-enumeration
  1402. enum **SamplerFilter**:
  1403. .. _class_RenderingDevice_constant_SAMPLER_FILTER_NEAREST:
  1404. .. rst-class:: classref-enumeration-constant
  1405. :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>` **SAMPLER_FILTER_NEAREST** = ``0``
  1406. Nearest-neighbor sampler filtering. Sampling at higher resolutions than the source will result in a pixelated look.
  1407. .. _class_RenderingDevice_constant_SAMPLER_FILTER_LINEAR:
  1408. .. rst-class:: classref-enumeration-constant
  1409. :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>` **SAMPLER_FILTER_LINEAR** = ``1``
  1410. Bilinear sampler filtering. Sampling at higher resolutions than the source will result in a blurry look.
  1411. .. rst-class:: classref-item-separator
  1412. ----
  1413. .. _enum_RenderingDevice_SamplerRepeatMode:
  1414. .. rst-class:: classref-enumeration
  1415. enum **SamplerRepeatMode**:
  1416. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_REPEAT:
  1417. .. rst-class:: classref-enumeration-constant
  1418. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_REPEAT** = ``0``
  1419. Sample with repeating enabled.
  1420. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRRORED_REPEAT:
  1421. .. rst-class:: classref-enumeration-constant
  1422. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_MIRRORED_REPEAT** = ``1``
  1423. 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.
  1424. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE:
  1425. .. rst-class:: classref-enumeration-constant
  1426. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE** = ``2``
  1427. Sample with repeating disabled. When sampling outside the ``[0.0, 1.0]`` range, return the color of the last pixel on the edge.
  1428. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER:
  1429. .. rst-class:: classref-enumeration-constant
  1430. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER** = ``3``
  1431. 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>`.
  1432. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE:
  1433. .. rst-class:: classref-enumeration-constant
  1434. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE** = ``4``
  1435. 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.
  1436. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MAX:
  1437. .. rst-class:: classref-enumeration-constant
  1438. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_MAX** = ``5``
  1439. Represents the size of the :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` enum.
  1440. .. rst-class:: classref-item-separator
  1441. ----
  1442. .. _enum_RenderingDevice_SamplerBorderColor:
  1443. .. rst-class:: classref-enumeration
  1444. enum **SamplerBorderColor**:
  1445. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK:
  1446. .. rst-class:: classref-enumeration-constant
  1447. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK** = ``0``
  1448. 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>`.
  1449. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK:
  1450. .. rst-class:: classref-enumeration-constant
  1451. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK** = ``1``
  1452. 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>`.
  1453. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK:
  1454. .. rst-class:: classref-enumeration-constant
  1455. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK** = ``2``
  1456. 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>`.
  1457. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK:
  1458. .. rst-class:: classref-enumeration-constant
  1459. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK** = ``3``
  1460. 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>`.
  1461. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE:
  1462. .. rst-class:: classref-enumeration-constant
  1463. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE** = ``4``
  1464. 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>`.
  1465. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE:
  1466. .. rst-class:: classref-enumeration-constant
  1467. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE** = ``5``
  1468. 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>`.
  1469. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_MAX:
  1470. .. rst-class:: classref-enumeration-constant
  1471. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_MAX** = ``6``
  1472. Represents the size of the :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` enum.
  1473. .. rst-class:: classref-item-separator
  1474. ----
  1475. .. _enum_RenderingDevice_VertexFrequency:
  1476. .. rst-class:: classref-enumeration
  1477. enum **VertexFrequency**:
  1478. .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_VERTEX:
  1479. .. rst-class:: classref-enumeration-constant
  1480. :ref:`VertexFrequency<enum_RenderingDevice_VertexFrequency>` **VERTEX_FREQUENCY_VERTEX** = ``0``
  1481. Vertex attribute addressing is a function of the vertex. This is used to specify the rate at which vertex attributes are pulled from buffers.
  1482. .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_INSTANCE:
  1483. .. rst-class:: classref-enumeration-constant
  1484. :ref:`VertexFrequency<enum_RenderingDevice_VertexFrequency>` **VERTEX_FREQUENCY_INSTANCE** = ``1``
  1485. 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.
  1486. .. rst-class:: classref-item-separator
  1487. ----
  1488. .. _enum_RenderingDevice_IndexBufferFormat:
  1489. .. rst-class:: classref-enumeration
  1490. enum **IndexBufferFormat**:
  1491. .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT16:
  1492. .. rst-class:: classref-enumeration-constant
  1493. :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` **INDEX_BUFFER_FORMAT_UINT16** = ``0``
  1494. Index buffer in 16-bit unsigned integer format. This limits the maximum index that can be specified to ``65535``.
  1495. .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT32:
  1496. .. rst-class:: classref-enumeration-constant
  1497. :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` **INDEX_BUFFER_FORMAT_UINT32** = ``1``
  1498. Index buffer in 32-bit unsigned integer format. This limits the maximum index that can be specified to ``4294967295``.
  1499. .. rst-class:: classref-item-separator
  1500. ----
  1501. .. _enum_RenderingDevice_StorageBufferUsage:
  1502. .. rst-class:: classref-enumeration
  1503. flags **StorageBufferUsage**:
  1504. .. _class_RenderingDevice_constant_STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT:
  1505. .. rst-class:: classref-enumeration-constant
  1506. :ref:`StorageBufferUsage<enum_RenderingDevice_StorageBufferUsage>` **STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT** = ``1``
  1507. .. rst-class:: classref-item-separator
  1508. ----
  1509. .. _enum_RenderingDevice_UniformType:
  1510. .. rst-class:: classref-enumeration
  1511. enum **UniformType**:
  1512. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER:
  1513. .. rst-class:: classref-enumeration-constant
  1514. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_SAMPLER** = ``0``
  1515. Sampler uniform.
  1516. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE:
  1517. .. rst-class:: classref-enumeration-constant
  1518. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE** = ``1``
  1519. Sampler uniform with a texture.
  1520. .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE:
  1521. .. rst-class:: classref-enumeration-constant
  1522. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_TEXTURE** = ``2``
  1523. Texture uniform.
  1524. .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE:
  1525. .. rst-class:: classref-enumeration-constant
  1526. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_IMAGE** = ``3``
  1527. Image uniform.
  1528. .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE_BUFFER:
  1529. .. rst-class:: classref-enumeration-constant
  1530. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_TEXTURE_BUFFER** = ``4``
  1531. Texture buffer uniform.
  1532. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER:
  1533. .. rst-class:: classref-enumeration-constant
  1534. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER** = ``5``
  1535. Sampler uniform with a texture buffer.
  1536. .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE_BUFFER:
  1537. .. rst-class:: classref-enumeration-constant
  1538. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_IMAGE_BUFFER** = ``6``
  1539. Image buffer uniform.
  1540. .. _class_RenderingDevice_constant_UNIFORM_TYPE_UNIFORM_BUFFER:
  1541. .. rst-class:: classref-enumeration-constant
  1542. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_UNIFORM_BUFFER** = ``7``
  1543. Uniform buffer uniform.
  1544. .. _class_RenderingDevice_constant_UNIFORM_TYPE_STORAGE_BUFFER:
  1545. .. rst-class:: classref-enumeration-constant
  1546. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_STORAGE_BUFFER** = ``8``
  1547. `Storage buffer <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ uniform.
  1548. .. _class_RenderingDevice_constant_UNIFORM_TYPE_INPUT_ATTACHMENT:
  1549. .. rst-class:: classref-enumeration-constant
  1550. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_INPUT_ATTACHMENT** = ``9``
  1551. Input attachment uniform.
  1552. .. _class_RenderingDevice_constant_UNIFORM_TYPE_MAX:
  1553. .. rst-class:: classref-enumeration-constant
  1554. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_MAX** = ``10``
  1555. Represents the size of the :ref:`UniformType<enum_RenderingDevice_UniformType>` enum.
  1556. .. rst-class:: classref-item-separator
  1557. ----
  1558. .. _enum_RenderingDevice_RenderPrimitive:
  1559. .. rst-class:: classref-enumeration
  1560. enum **RenderPrimitive**:
  1561. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_POINTS:
  1562. .. rst-class:: classref-enumeration-constant
  1563. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_POINTS** = ``0``
  1564. Point rendering primitive (with constant size, regardless of distance from camera).
  1565. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES:
  1566. .. rst-class:: classref-enumeration-constant
  1567. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINES** = ``1``
  1568. Line list rendering primitive. Lines are drawn separated from each other.
  1569. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES_WITH_ADJACENCY:
  1570. .. rst-class:: classref-enumeration-constant
  1571. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINES_WITH_ADJACENCY** = ``2``
  1572. `Line list rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-line-lists-with-adjacency>`__\
  1573. \ **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1574. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS:
  1575. .. rst-class:: classref-enumeration-constant
  1576. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINESTRIPS** = ``3``
  1577. Line strip rendering primitive. Lines drawn are connected to the previous vertex.
  1578. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY:
  1579. .. rst-class:: classref-enumeration-constant
  1580. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY** = ``4``
  1581. `Line strip rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-line-strips-with-adjacency>`__\
  1582. \ **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1583. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES:
  1584. .. rst-class:: classref-enumeration-constant
  1585. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLES** = ``5``
  1586. Triangle list rendering primitive. Triangles are drawn separated from each other.
  1587. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY:
  1588. .. rst-class:: classref-enumeration-constant
  1589. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY** = ``6``
  1590. `Triangle list rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-triangle-lists-with-adjacency>`__\
  1591. **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1592. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS:
  1593. .. rst-class:: classref-enumeration-constant
  1594. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLE_STRIPS** = ``7``
  1595. Triangle strip rendering primitive. Triangles drawn are connected to the previous triangle.
  1596. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY:
  1597. .. rst-class:: classref-enumeration-constant
  1598. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY** = ``8``
  1599. `Triangle strip rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-triangle-strips-with-adjacency>`__\
  1600. \ **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1601. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX:
  1602. .. rst-class:: classref-enumeration-constant
  1603. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX** = ``9``
  1604. 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.
  1605. \ **Note:** Only compatible with indexed draws.
  1606. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TESSELATION_PATCH:
  1607. .. rst-class:: classref-enumeration-constant
  1608. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TESSELATION_PATCH** = ``10``
  1609. Tessellation patch rendering primitive. Only useful with tessellation shaders, which can be used to deform these patches.
  1610. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_MAX:
  1611. .. rst-class:: classref-enumeration-constant
  1612. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_MAX** = ``11``
  1613. Represents the size of the :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` enum.
  1614. .. rst-class:: classref-item-separator
  1615. ----
  1616. .. _enum_RenderingDevice_PolygonCullMode:
  1617. .. rst-class:: classref-enumeration
  1618. enum **PolygonCullMode**:
  1619. .. _class_RenderingDevice_constant_POLYGON_CULL_DISABLED:
  1620. .. rst-class:: classref-enumeration-constant
  1621. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **POLYGON_CULL_DISABLED** = ``0``
  1622. Do not use polygon front face or backface culling.
  1623. .. _class_RenderingDevice_constant_POLYGON_CULL_FRONT:
  1624. .. rst-class:: classref-enumeration-constant
  1625. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **POLYGON_CULL_FRONT** = ``1``
  1626. Use polygon frontface culling (faces pointing towards the camera are hidden).
  1627. .. _class_RenderingDevice_constant_POLYGON_CULL_BACK:
  1628. .. rst-class:: classref-enumeration-constant
  1629. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **POLYGON_CULL_BACK** = ``2``
  1630. Use polygon backface culling (faces pointing away from the camera are hidden).
  1631. .. rst-class:: classref-item-separator
  1632. ----
  1633. .. _enum_RenderingDevice_PolygonFrontFace:
  1634. .. rst-class:: classref-enumeration
  1635. enum **PolygonFrontFace**:
  1636. .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_CLOCKWISE:
  1637. .. rst-class:: classref-enumeration-constant
  1638. :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` **POLYGON_FRONT_FACE_CLOCKWISE** = ``0``
  1639. Clockwise winding order to determine which face of a polygon is its front face.
  1640. .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_COUNTER_CLOCKWISE:
  1641. .. rst-class:: classref-enumeration-constant
  1642. :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` **POLYGON_FRONT_FACE_COUNTER_CLOCKWISE** = ``1``
  1643. Counter-clockwise winding order to determine which face of a polygon is its front face.
  1644. .. rst-class:: classref-item-separator
  1645. ----
  1646. .. _enum_RenderingDevice_StencilOperation:
  1647. .. rst-class:: classref-enumeration
  1648. enum **StencilOperation**:
  1649. .. _class_RenderingDevice_constant_STENCIL_OP_KEEP:
  1650. .. rst-class:: classref-enumeration-constant
  1651. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_KEEP** = ``0``
  1652. Keep the current stencil value.
  1653. .. _class_RenderingDevice_constant_STENCIL_OP_ZERO:
  1654. .. rst-class:: classref-enumeration-constant
  1655. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_ZERO** = ``1``
  1656. Set the stencil value to ``0``.
  1657. .. _class_RenderingDevice_constant_STENCIL_OP_REPLACE:
  1658. .. rst-class:: classref-enumeration-constant
  1659. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_REPLACE** = ``2``
  1660. Replace the existing stencil value with the new one.
  1661. .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_CLAMP:
  1662. .. rst-class:: classref-enumeration-constant
  1663. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_INCREMENT_AND_CLAMP** = ``3``
  1664. Increment the existing stencil value and clamp to the maximum representable unsigned value if reached. Stencil bits are considered as an unsigned integer.
  1665. .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_CLAMP:
  1666. .. rst-class:: classref-enumeration-constant
  1667. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_DECREMENT_AND_CLAMP** = ``4``
  1668. Decrement the existing stencil value and clamp to the minimum value if reached. Stencil bits are considered as an unsigned integer.
  1669. .. _class_RenderingDevice_constant_STENCIL_OP_INVERT:
  1670. .. rst-class:: classref-enumeration-constant
  1671. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_INVERT** = ``5``
  1672. Bitwise-invert the existing stencil value.
  1673. .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_WRAP:
  1674. .. rst-class:: classref-enumeration-constant
  1675. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_INCREMENT_AND_WRAP** = ``6``
  1676. Increment the stencil value and wrap around to ``0`` if reaching the maximum representable unsigned. Stencil bits are considered as an unsigned integer.
  1677. .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_WRAP:
  1678. .. rst-class:: classref-enumeration-constant
  1679. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_DECREMENT_AND_WRAP** = ``7``
  1680. Decrement the stencil value and wrap around to the maximum representable unsigned if reaching the minimum. Stencil bits are considered as an unsigned integer.
  1681. .. _class_RenderingDevice_constant_STENCIL_OP_MAX:
  1682. .. rst-class:: classref-enumeration-constant
  1683. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_MAX** = ``8``
  1684. Represents the size of the :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` enum.
  1685. .. rst-class:: classref-item-separator
  1686. ----
  1687. .. _enum_RenderingDevice_CompareOperator:
  1688. .. rst-class:: classref-enumeration
  1689. enum **CompareOperator**:
  1690. .. _class_RenderingDevice_constant_COMPARE_OP_NEVER:
  1691. .. rst-class:: classref-enumeration-constant
  1692. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_NEVER** = ``0``
  1693. "Never" comparison (opposite of :ref:`COMPARE_OP_ALWAYS<class_RenderingDevice_constant_COMPARE_OP_ALWAYS>`).
  1694. .. _class_RenderingDevice_constant_COMPARE_OP_LESS:
  1695. .. rst-class:: classref-enumeration-constant
  1696. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_LESS** = ``1``
  1697. "Less than" comparison.
  1698. .. _class_RenderingDevice_constant_COMPARE_OP_EQUAL:
  1699. .. rst-class:: classref-enumeration-constant
  1700. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_EQUAL** = ``2``
  1701. "Equal" comparison.
  1702. .. _class_RenderingDevice_constant_COMPARE_OP_LESS_OR_EQUAL:
  1703. .. rst-class:: classref-enumeration-constant
  1704. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_LESS_OR_EQUAL** = ``3``
  1705. "Less than or equal" comparison.
  1706. .. _class_RenderingDevice_constant_COMPARE_OP_GREATER:
  1707. .. rst-class:: classref-enumeration-constant
  1708. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_GREATER** = ``4``
  1709. "Greater than" comparison.
  1710. .. _class_RenderingDevice_constant_COMPARE_OP_NOT_EQUAL:
  1711. .. rst-class:: classref-enumeration-constant
  1712. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_NOT_EQUAL** = ``5``
  1713. "Not equal" comparison.
  1714. .. _class_RenderingDevice_constant_COMPARE_OP_GREATER_OR_EQUAL:
  1715. .. rst-class:: classref-enumeration-constant
  1716. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_GREATER_OR_EQUAL** = ``6``
  1717. "Greater than or equal" comparison.
  1718. .. _class_RenderingDevice_constant_COMPARE_OP_ALWAYS:
  1719. .. rst-class:: classref-enumeration-constant
  1720. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_ALWAYS** = ``7``
  1721. "Always" comparison (opposite of :ref:`COMPARE_OP_NEVER<class_RenderingDevice_constant_COMPARE_OP_NEVER>`).
  1722. .. _class_RenderingDevice_constant_COMPARE_OP_MAX:
  1723. .. rst-class:: classref-enumeration-constant
  1724. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_MAX** = ``8``
  1725. Represents the size of the :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` enum.
  1726. .. rst-class:: classref-item-separator
  1727. ----
  1728. .. _enum_RenderingDevice_LogicOperation:
  1729. .. rst-class:: classref-enumeration
  1730. enum **LogicOperation**:
  1731. .. _class_RenderingDevice_constant_LOGIC_OP_CLEAR:
  1732. .. rst-class:: classref-enumeration-constant
  1733. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_CLEAR** = ``0``
  1734. Clear logic operation (result is always ``0``). See also :ref:`LOGIC_OP_SET<class_RenderingDevice_constant_LOGIC_OP_SET>`.
  1735. .. _class_RenderingDevice_constant_LOGIC_OP_AND:
  1736. .. rst-class:: classref-enumeration-constant
  1737. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_AND** = ``1``
  1738. AND logic operation.
  1739. .. _class_RenderingDevice_constant_LOGIC_OP_AND_REVERSE:
  1740. .. rst-class:: classref-enumeration-constant
  1741. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_AND_REVERSE** = ``2``
  1742. AND logic operation with the *destination* operand being inverted. See also :ref:`LOGIC_OP_AND_INVERTED<class_RenderingDevice_constant_LOGIC_OP_AND_INVERTED>`.
  1743. .. _class_RenderingDevice_constant_LOGIC_OP_COPY:
  1744. .. rst-class:: classref-enumeration-constant
  1745. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_COPY** = ``3``
  1746. 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>`.
  1747. .. _class_RenderingDevice_constant_LOGIC_OP_AND_INVERTED:
  1748. .. rst-class:: classref-enumeration-constant
  1749. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_AND_INVERTED** = ``4``
  1750. AND logic operation with the *source* operand being inverted. See also :ref:`LOGIC_OP_AND_REVERSE<class_RenderingDevice_constant_LOGIC_OP_AND_REVERSE>`.
  1751. .. _class_RenderingDevice_constant_LOGIC_OP_NO_OP:
  1752. .. rst-class:: classref-enumeration-constant
  1753. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_NO_OP** = ``5``
  1754. No-op logic operation (keeps the *destination* value as-is). See also :ref:`LOGIC_OP_COPY<class_RenderingDevice_constant_LOGIC_OP_COPY>`.
  1755. .. _class_RenderingDevice_constant_LOGIC_OP_XOR:
  1756. .. rst-class:: classref-enumeration-constant
  1757. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_XOR** = ``6``
  1758. Exclusive or (XOR) logic operation.
  1759. .. _class_RenderingDevice_constant_LOGIC_OP_OR:
  1760. .. rst-class:: classref-enumeration-constant
  1761. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_OR** = ``7``
  1762. OR logic operation.
  1763. .. _class_RenderingDevice_constant_LOGIC_OP_NOR:
  1764. .. rst-class:: classref-enumeration-constant
  1765. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_NOR** = ``8``
  1766. Not-OR (NOR) logic operation.
  1767. .. _class_RenderingDevice_constant_LOGIC_OP_EQUIVALENT:
  1768. .. rst-class:: classref-enumeration-constant
  1769. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_EQUIVALENT** = ``9``
  1770. Not-XOR (XNOR) logic operation.
  1771. .. _class_RenderingDevice_constant_LOGIC_OP_INVERT:
  1772. .. rst-class:: classref-enumeration-constant
  1773. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_INVERT** = ``10``
  1774. Invert logic operation.
  1775. .. _class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE:
  1776. .. rst-class:: classref-enumeration-constant
  1777. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_OR_REVERSE** = ``11``
  1778. OR logic operation with the *destination* operand being inverted. See also :ref:`LOGIC_OP_OR_REVERSE<class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE>`.
  1779. .. _class_RenderingDevice_constant_LOGIC_OP_COPY_INVERTED:
  1780. .. rst-class:: classref-enumeration-constant
  1781. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_COPY_INVERTED** = ``12``
  1782. NOT logic operation (inverts the value). See also :ref:`LOGIC_OP_COPY<class_RenderingDevice_constant_LOGIC_OP_COPY>`.
  1783. .. _class_RenderingDevice_constant_LOGIC_OP_OR_INVERTED:
  1784. .. rst-class:: classref-enumeration-constant
  1785. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_OR_INVERTED** = ``13``
  1786. OR logic operation with the *source* operand being inverted. See also :ref:`LOGIC_OP_OR_REVERSE<class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE>`.
  1787. .. _class_RenderingDevice_constant_LOGIC_OP_NAND:
  1788. .. rst-class:: classref-enumeration-constant
  1789. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_NAND** = ``14``
  1790. Not-AND (NAND) logic operation.
  1791. .. _class_RenderingDevice_constant_LOGIC_OP_SET:
  1792. .. rst-class:: classref-enumeration-constant
  1793. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_SET** = ``15``
  1794. SET logic operation (result is always ``1``). See also :ref:`LOGIC_OP_CLEAR<class_RenderingDevice_constant_LOGIC_OP_CLEAR>`.
  1795. .. _class_RenderingDevice_constant_LOGIC_OP_MAX:
  1796. .. rst-class:: classref-enumeration-constant
  1797. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_MAX** = ``16``
  1798. Represents the size of the :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` enum.
  1799. .. rst-class:: classref-item-separator
  1800. ----
  1801. .. _enum_RenderingDevice_BlendFactor:
  1802. .. rst-class:: classref-enumeration
  1803. enum **BlendFactor**:
  1804. .. _class_RenderingDevice_constant_BLEND_FACTOR_ZERO:
  1805. .. rst-class:: classref-enumeration-constant
  1806. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ZERO** = ``0``
  1807. Constant ``0.0`` blend factor.
  1808. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE:
  1809. .. rst-class:: classref-enumeration-constant
  1810. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE** = ``1``
  1811. Constant ``1.0`` blend factor.
  1812. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_COLOR:
  1813. .. rst-class:: classref-enumeration-constant
  1814. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC_COLOR** = ``2``
  1815. Color blend factor is ``source color``. Alpha blend factor is ``source alpha``.
  1816. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_COLOR:
  1817. .. rst-class:: classref-enumeration-constant
  1818. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC_COLOR** = ``3``
  1819. Color blend factor is ``1.0 - source color``. Alpha blend factor is ``1.0 - source alpha``.
  1820. .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_COLOR:
  1821. .. rst-class:: classref-enumeration-constant
  1822. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_DST_COLOR** = ``4``
  1823. Color blend factor is ``destination color``. Alpha blend factor is ``destination alpha``.
  1824. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_COLOR:
  1825. .. rst-class:: classref-enumeration-constant
  1826. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_DST_COLOR** = ``5``
  1827. Color blend factor is ``1.0 - destination color``. Alpha blend factor is ``1.0 - destination alpha``.
  1828. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA:
  1829. .. rst-class:: classref-enumeration-constant
  1830. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC_ALPHA** = ``6``
  1831. Color and alpha blend factor is ``source alpha``.
  1832. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA:
  1833. .. rst-class:: classref-enumeration-constant
  1834. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC_ALPHA** = ``7``
  1835. Color and alpha blend factor is ``1.0 - source alpha``.
  1836. .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_ALPHA:
  1837. .. rst-class:: classref-enumeration-constant
  1838. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_DST_ALPHA** = ``8``
  1839. Color and alpha blend factor is ``destination alpha``.
  1840. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_ALPHA:
  1841. .. rst-class:: classref-enumeration-constant
  1842. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_DST_ALPHA** = ``9``
  1843. Color and alpha blend factor is ``1.0 - destination alpha``.
  1844. .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_COLOR:
  1845. .. rst-class:: classref-enumeration-constant
  1846. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_CONSTANT_COLOR** = ``10``
  1847. 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>`).
  1848. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR:
  1849. .. rst-class:: classref-enumeration-constant
  1850. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR** = ``11``
  1851. 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>`).
  1852. .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_ALPHA:
  1853. .. rst-class:: classref-enumeration-constant
  1854. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_CONSTANT_ALPHA** = ``12``
  1855. Color and alpha blend factor is ``blend constant alpha`` (see :ref:`draw_list_set_blend_constants<class_RenderingDevice_method_draw_list_set_blend_constants>`).
  1856. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA:
  1857. .. rst-class:: classref-enumeration-constant
  1858. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA** = ``13``
  1859. 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>`).
  1860. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA_SATURATE:
  1861. .. rst-class:: classref-enumeration-constant
  1862. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC_ALPHA_SATURATE** = ``14``
  1863. Color blend factor is ``min(source alpha, 1.0 - destination alpha)``. Alpha blend factor is ``1.0``.
  1864. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_COLOR:
  1865. .. rst-class:: classref-enumeration-constant
  1866. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC1_COLOR** = ``15``
  1867. Color blend factor is ``second source color``. Alpha blend factor is ``second source alpha``. Only relevant for dual-source blending.
  1868. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR:
  1869. .. rst-class:: classref-enumeration-constant
  1870. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC1_COLOR** = ``16``
  1871. Color blend factor is ``1.0 - second source color``. Alpha blend factor is ``1.0 - second source alpha``. Only relevant for dual-source blending.
  1872. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_ALPHA:
  1873. .. rst-class:: classref-enumeration-constant
  1874. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC1_ALPHA** = ``17``
  1875. Color and alpha blend factor is ``second source alpha``. Only relevant for dual-source blending.
  1876. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA:
  1877. .. rst-class:: classref-enumeration-constant
  1878. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA** = ``18``
  1879. Color and alpha blend factor is ``1.0 - second source alpha``. Only relevant for dual-source blending.
  1880. .. _class_RenderingDevice_constant_BLEND_FACTOR_MAX:
  1881. .. rst-class:: classref-enumeration-constant
  1882. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_MAX** = ``19``
  1883. Represents the size of the :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` enum.
  1884. .. rst-class:: classref-item-separator
  1885. ----
  1886. .. _enum_RenderingDevice_BlendOperation:
  1887. .. rst-class:: classref-enumeration
  1888. enum **BlendOperation**:
  1889. .. _class_RenderingDevice_constant_BLEND_OP_ADD:
  1890. .. rst-class:: classref-enumeration-constant
  1891. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_ADD** = ``0``
  1892. Additive blending operation (``source + destination``).
  1893. .. _class_RenderingDevice_constant_BLEND_OP_SUBTRACT:
  1894. .. rst-class:: classref-enumeration-constant
  1895. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_SUBTRACT** = ``1``
  1896. Subtractive blending operation (``source - destination``).
  1897. .. _class_RenderingDevice_constant_BLEND_OP_REVERSE_SUBTRACT:
  1898. .. rst-class:: classref-enumeration-constant
  1899. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_REVERSE_SUBTRACT** = ``2``
  1900. Reverse subtractive blending operation (``destination - source``).
  1901. .. _class_RenderingDevice_constant_BLEND_OP_MINIMUM:
  1902. .. rst-class:: classref-enumeration-constant
  1903. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_MINIMUM** = ``3``
  1904. Minimum blending operation (keep the lowest value of the two).
  1905. .. _class_RenderingDevice_constant_BLEND_OP_MAXIMUM:
  1906. .. rst-class:: classref-enumeration-constant
  1907. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_MAXIMUM** = ``4``
  1908. Maximum blending operation (keep the highest value of the two).
  1909. .. _class_RenderingDevice_constant_BLEND_OP_MAX:
  1910. .. rst-class:: classref-enumeration-constant
  1911. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_MAX** = ``5``
  1912. Represents the size of the :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` enum.
  1913. .. rst-class:: classref-item-separator
  1914. ----
  1915. .. _enum_RenderingDevice_PipelineDynamicStateFlags:
  1916. .. rst-class:: classref-enumeration
  1917. flags **PipelineDynamicStateFlags**:
  1918. .. _class_RenderingDevice_constant_DYNAMIC_STATE_LINE_WIDTH:
  1919. .. rst-class:: classref-enumeration-constant
  1920. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_LINE_WIDTH** = ``1``
  1921. .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BIAS:
  1922. .. rst-class:: classref-enumeration-constant
  1923. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_DEPTH_BIAS** = ``2``
  1924. .. _class_RenderingDevice_constant_DYNAMIC_STATE_BLEND_CONSTANTS:
  1925. .. rst-class:: classref-enumeration-constant
  1926. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_BLEND_CONSTANTS** = ``4``
  1927. .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BOUNDS:
  1928. .. rst-class:: classref-enumeration-constant
  1929. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_DEPTH_BOUNDS** = ``8``
  1930. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_COMPARE_MASK:
  1931. .. rst-class:: classref-enumeration-constant
  1932. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_STENCIL_COMPARE_MASK** = ``16``
  1933. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_WRITE_MASK:
  1934. .. rst-class:: classref-enumeration-constant
  1935. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_STENCIL_WRITE_MASK** = ``32``
  1936. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_REFERENCE:
  1937. .. rst-class:: classref-enumeration-constant
  1938. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_STENCIL_REFERENCE** = ``64``
  1939. .. rst-class:: classref-item-separator
  1940. ----
  1941. .. _enum_RenderingDevice_InitialAction:
  1942. .. rst-class:: classref-enumeration
  1943. enum **InitialAction**:
  1944. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR:
  1945. .. rst-class:: classref-enumeration-constant
  1946. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CLEAR** = ``0``
  1947. Start rendering and clear the whole framebuffer.
  1948. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION:
  1949. .. rst-class:: classref-enumeration-constant
  1950. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CLEAR_REGION** = ``1``
  1951. Start rendering and clear the framebuffer in the specified region.
  1952. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION_CONTINUE:
  1953. .. rst-class:: classref-enumeration-constant
  1954. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CLEAR_REGION_CONTINUE** = ``2``
  1955. Continue rendering and clear the framebuffer in the specified region. Framebuffer must have been left in :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>` state as the final action previously.
  1956. .. _class_RenderingDevice_constant_INITIAL_ACTION_KEEP:
  1957. .. rst-class:: classref-enumeration-constant
  1958. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_KEEP** = ``3``
  1959. Start rendering, but keep attached color texture contents. If the framebuffer was previously used to read in a shader, this will automatically insert a layout transition.
  1960. .. _class_RenderingDevice_constant_INITIAL_ACTION_DROP:
  1961. .. rst-class:: classref-enumeration-constant
  1962. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_DROP** = ``4``
  1963. Start rendering, ignore what is there; write above it. In general, this is the fastest option when you will be writing every single pixel and you don't need a clear color.
  1964. .. _class_RenderingDevice_constant_INITIAL_ACTION_CONTINUE:
  1965. .. rst-class:: classref-enumeration-constant
  1966. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CONTINUE** = ``5``
  1967. Continue rendering. Framebuffer must have been left in :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>` state as the final action previously.
  1968. .. _class_RenderingDevice_constant_INITIAL_ACTION_MAX:
  1969. .. rst-class:: classref-enumeration-constant
  1970. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_MAX** = ``6``
  1971. Represents the size of the :ref:`InitialAction<enum_RenderingDevice_InitialAction>` enum.
  1972. .. rst-class:: classref-item-separator
  1973. ----
  1974. .. _enum_RenderingDevice_FinalAction:
  1975. .. rst-class:: classref-enumeration
  1976. enum **FinalAction**:
  1977. .. _class_RenderingDevice_constant_FINAL_ACTION_READ:
  1978. .. rst-class:: classref-enumeration-constant
  1979. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_READ** = ``0``
  1980. Store the texture for reading and make it read-only if it has the :ref:`TEXTURE_USAGE_SAMPLING_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_SAMPLING_BIT>` bit (only applies to color, depth and stencil attachments).
  1981. .. _class_RenderingDevice_constant_FINAL_ACTION_DISCARD:
  1982. .. rst-class:: classref-enumeration-constant
  1983. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_DISCARD** = ``1``
  1984. Discard the texture data and make it read-only if it has the :ref:`TEXTURE_USAGE_SAMPLING_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_SAMPLING_BIT>` bit (only applies to color, depth and stencil attachments).
  1985. .. _class_RenderingDevice_constant_FINAL_ACTION_CONTINUE:
  1986. .. rst-class:: classref-enumeration-constant
  1987. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_CONTINUE** = ``2``
  1988. Store the texture and continue for further processing. Similar to :ref:`FINAL_ACTION_READ<class_RenderingDevice_constant_FINAL_ACTION_READ>`, but does not make the texture read-only if it has the :ref:`TEXTURE_USAGE_SAMPLING_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_SAMPLING_BIT>` bit.
  1989. .. _class_RenderingDevice_constant_FINAL_ACTION_MAX:
  1990. .. rst-class:: classref-enumeration-constant
  1991. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_MAX** = ``3``
  1992. Represents the size of the :ref:`FinalAction<enum_RenderingDevice_FinalAction>` enum.
  1993. .. rst-class:: classref-item-separator
  1994. ----
  1995. .. _enum_RenderingDevice_ShaderStage:
  1996. .. rst-class:: classref-enumeration
  1997. enum **ShaderStage**:
  1998. .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX:
  1999. .. rst-class:: classref-enumeration-constant
  2000. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_VERTEX** = ``0``
  2001. Vertex shader stage. This can be used to manipulate vertices from a shader (but not create new vertices).
  2002. .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT:
  2003. .. rst-class:: classref-enumeration-constant
  2004. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_FRAGMENT** = ``1``
  2005. Fragment shader stage (called "pixel shader" in Direct3D). This can be used to manipulate pixels from a shader.
  2006. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL:
  2007. .. rst-class:: classref-enumeration-constant
  2008. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_CONTROL** = ``2``
  2009. Tessellation control shader stage. This can be used to create additional geometry from a shader.
  2010. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION:
  2011. .. rst-class:: classref-enumeration-constant
  2012. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_EVALUATION** = ``3``
  2013. Tessellation evaluation shader stage. This can be used to create additional geometry from a shader.
  2014. .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE:
  2015. .. rst-class:: classref-enumeration-constant
  2016. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_COMPUTE** = ``4``
  2017. Compute shader stage. This can be used to run arbitrary computing tasks in a shader, performing them on the GPU instead of the CPU.
  2018. .. _class_RenderingDevice_constant_SHADER_STAGE_MAX:
  2019. .. rst-class:: classref-enumeration-constant
  2020. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_MAX** = ``5``
  2021. Represents the size of the :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` enum.
  2022. .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX_BIT:
  2023. .. rst-class:: classref-enumeration-constant
  2024. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_VERTEX_BIT** = ``1``
  2025. Vertex shader stage bit (see also :ref:`SHADER_STAGE_VERTEX<class_RenderingDevice_constant_SHADER_STAGE_VERTEX>`).
  2026. .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT_BIT:
  2027. .. rst-class:: classref-enumeration-constant
  2028. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_FRAGMENT_BIT** = ``2``
  2029. Fragment shader stage bit (see also :ref:`SHADER_STAGE_FRAGMENT<class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT>`).
  2030. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL_BIT:
  2031. .. rst-class:: classref-enumeration-constant
  2032. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_CONTROL_BIT** = ``4``
  2033. Tessellation control shader stage bit (see also :ref:`SHADER_STAGE_TESSELATION_CONTROL<class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL>`).
  2034. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION_BIT:
  2035. .. rst-class:: classref-enumeration-constant
  2036. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_EVALUATION_BIT** = ``8``
  2037. Tessellation evaluation shader stage bit (see also :ref:`SHADER_STAGE_TESSELATION_EVALUATION<class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION>`).
  2038. .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE_BIT:
  2039. .. rst-class:: classref-enumeration-constant
  2040. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_COMPUTE_BIT** = ``16``
  2041. Compute shader stage bit (see also :ref:`SHADER_STAGE_COMPUTE<class_RenderingDevice_constant_SHADER_STAGE_COMPUTE>`).
  2042. .. rst-class:: classref-item-separator
  2043. ----
  2044. .. _enum_RenderingDevice_ShaderLanguage:
  2045. .. rst-class:: classref-enumeration
  2046. enum **ShaderLanguage**:
  2047. .. _class_RenderingDevice_constant_SHADER_LANGUAGE_GLSL:
  2048. .. rst-class:: classref-enumeration-constant
  2049. :ref:`ShaderLanguage<enum_RenderingDevice_ShaderLanguage>` **SHADER_LANGUAGE_GLSL** = ``0``
  2050. Khronos' GLSL shading language (used natively by OpenGL and Vulkan). This is the language used for core Godot shaders.
  2051. .. _class_RenderingDevice_constant_SHADER_LANGUAGE_HLSL:
  2052. .. rst-class:: classref-enumeration-constant
  2053. :ref:`ShaderLanguage<enum_RenderingDevice_ShaderLanguage>` **SHADER_LANGUAGE_HLSL** = ``1``
  2054. Microsoft's High-Level Shading Language (used natively by Direct3D, but can also be used in Vulkan).
  2055. .. rst-class:: classref-item-separator
  2056. ----
  2057. .. _enum_RenderingDevice_PipelineSpecializationConstantType:
  2058. .. rst-class:: classref-enumeration
  2059. enum **PipelineSpecializationConstantType**:
  2060. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL:
  2061. .. rst-class:: classref-enumeration-constant
  2062. :ref:`PipelineSpecializationConstantType<enum_RenderingDevice_PipelineSpecializationConstantType>` **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL** = ``0``
  2063. Boolean specialization constant.
  2064. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT:
  2065. .. rst-class:: classref-enumeration-constant
  2066. :ref:`PipelineSpecializationConstantType<enum_RenderingDevice_PipelineSpecializationConstantType>` **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT** = ``1``
  2067. Integer specialization constant.
  2068. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT:
  2069. .. rst-class:: classref-enumeration-constant
  2070. :ref:`PipelineSpecializationConstantType<enum_RenderingDevice_PipelineSpecializationConstantType>` **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT** = ``2``
  2071. Floating-point specialization constant.
  2072. .. rst-class:: classref-item-separator
  2073. ----
  2074. .. _enum_RenderingDevice_Limit:
  2075. .. rst-class:: classref-enumeration
  2076. enum **Limit**:
  2077. .. _class_RenderingDevice_constant_LIMIT_MAX_BOUND_UNIFORM_SETS:
  2078. .. rst-class:: classref-enumeration-constant
  2079. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_BOUND_UNIFORM_SETS** = ``0``
  2080. Maximum number of uniform sets that can be bound at a given time.
  2081. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS:
  2082. .. rst-class:: classref-enumeration-constant
  2083. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS** = ``1``
  2084. Maximum number of color framebuffer attachments that can be used at a given time.
  2085. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_UNIFORM_SET:
  2086. .. rst-class:: classref-enumeration-constant
  2087. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURES_PER_UNIFORM_SET** = ``2``
  2088. Maximum number of textures that can be used per uniform set.
  2089. .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET:
  2090. .. rst-class:: classref-enumeration-constant
  2091. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET** = ``3``
  2092. Maximum number of samplers that can be used per uniform set.
  2093. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET:
  2094. .. rst-class:: classref-enumeration-constant
  2095. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET** = ``4``
  2096. Maximum number of `storage buffers <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ per uniform set.
  2097. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET:
  2098. .. rst-class:: classref-enumeration-constant
  2099. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET** = ``5``
  2100. Maximum number of storage images per uniform set.
  2101. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET:
  2102. .. rst-class:: classref-enumeration-constant
  2103. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET** = ``6``
  2104. Maximum number of uniform buffers per uniform set.
  2105. .. _class_RenderingDevice_constant_LIMIT_MAX_DRAW_INDEXED_INDEX:
  2106. .. rst-class:: classref-enumeration-constant
  2107. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_DRAW_INDEXED_INDEX** = ``7``
  2108. Maximum index for an indexed draw command.
  2109. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_HEIGHT:
  2110. .. rst-class:: classref-enumeration-constant
  2111. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_FRAMEBUFFER_HEIGHT** = ``8``
  2112. Maximum height of a framebuffer (in pixels).
  2113. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_WIDTH:
  2114. .. rst-class:: classref-enumeration-constant
  2115. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_FRAMEBUFFER_WIDTH** = ``9``
  2116. Maximum width of a framebuffer (in pixels).
  2117. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_ARRAY_LAYERS:
  2118. .. rst-class:: classref-enumeration-constant
  2119. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_ARRAY_LAYERS** = ``10``
  2120. Maximum number of texture array layers.
  2121. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_1D:
  2122. .. rst-class:: classref-enumeration-constant
  2123. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_1D** = ``11``
  2124. Maximum supported 1-dimensional texture size (in pixels on a single axis).
  2125. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_2D:
  2126. .. rst-class:: classref-enumeration-constant
  2127. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_2D** = ``12``
  2128. Maximum supported 2-dimensional texture size (in pixels on a single axis).
  2129. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_3D:
  2130. .. rst-class:: classref-enumeration-constant
  2131. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_3D** = ``13``
  2132. Maximum supported 3-dimensional texture size (in pixels on a single axis).
  2133. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_CUBE:
  2134. .. rst-class:: classref-enumeration-constant
  2135. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_CUBE** = ``14``
  2136. Maximum supported cubemap texture size (in pixels on a single axis of a single face).
  2137. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_SHADER_STAGE:
  2138. .. rst-class:: classref-enumeration-constant
  2139. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURES_PER_SHADER_STAGE** = ``15``
  2140. Maximum number of textures per shader stage.
  2141. .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE:
  2142. .. rst-class:: classref-enumeration-constant
  2143. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE** = ``16``
  2144. Maximum number of samplers per shader stage.
  2145. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE:
  2146. .. rst-class:: classref-enumeration-constant
  2147. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE** = ``17``
  2148. Maximum number of `storage buffers <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ per shader stage.
  2149. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE:
  2150. .. rst-class:: classref-enumeration-constant
  2151. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE** = ``18``
  2152. Maximum number of storage images per shader stage.
  2153. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE:
  2154. .. rst-class:: classref-enumeration-constant
  2155. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE** = ``19``
  2156. Maximum number of uniform buffers per uniform set.
  2157. .. _class_RenderingDevice_constant_LIMIT_MAX_PUSH_CONSTANT_SIZE:
  2158. .. rst-class:: classref-enumeration-constant
  2159. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_PUSH_CONSTANT_SIZE** = ``20``
  2160. 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.
  2161. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFER_SIZE:
  2162. .. rst-class:: classref-enumeration-constant
  2163. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_UNIFORM_BUFFER_SIZE** = ``21``
  2164. Maximum size of a uniform buffer.
  2165. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET:
  2166. .. rst-class:: classref-enumeration-constant
  2167. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET** = ``22``
  2168. Maximum vertex input attribute offset.
  2169. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES:
  2170. .. rst-class:: classref-enumeration-constant
  2171. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES** = ``23``
  2172. Maximum number of vertex input attributes.
  2173. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDINGS:
  2174. .. rst-class:: classref-enumeration-constant
  2175. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_BINDINGS** = ``24``
  2176. Maximum number of vertex input bindings.
  2177. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE:
  2178. .. rst-class:: classref-enumeration-constant
  2179. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE** = ``25``
  2180. Maximum vertex input binding stride.
  2181. .. _class_RenderingDevice_constant_LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT:
  2182. .. rst-class:: classref-enumeration-constant
  2183. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT** = ``26``
  2184. Minimum uniform buffer offset alignment.
  2185. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE:
  2186. .. rst-class:: classref-enumeration-constant
  2187. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE** = ``27``
  2188. Maximum shared memory size for compute shaders.
  2189. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X:
  2190. .. rst-class:: classref-enumeration-constant
  2191. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X** = ``28``
  2192. Maximum number of workgroups for compute shaders on the X axis.
  2193. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y:
  2194. .. rst-class:: classref-enumeration-constant
  2195. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y** = ``29``
  2196. Maximum number of workgroups for compute shaders on the Y axis.
  2197. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z:
  2198. .. rst-class:: classref-enumeration-constant
  2199. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z** = ``30``
  2200. Maximum number of workgroups for compute shaders on the Z axis.
  2201. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS:
  2202. .. rst-class:: classref-enumeration-constant
  2203. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS** = ``31``
  2204. Maximum number of workgroup invocations for compute shaders.
  2205. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X:
  2206. .. rst-class:: classref-enumeration-constant
  2207. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X** = ``32``
  2208. Maximum workgroup size for compute shaders on the X axis.
  2209. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y:
  2210. .. rst-class:: classref-enumeration-constant
  2211. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y** = ``33``
  2212. Maximum workgroup size for compute shaders on the Y axis.
  2213. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z:
  2214. .. rst-class:: classref-enumeration-constant
  2215. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z** = ``34``
  2216. Maximum workgroup size for compute shaders on the Z axis.
  2217. .. _class_RenderingDevice_constant_LIMIT_MAX_VIEWPORT_DIMENSIONS_X:
  2218. .. rst-class:: classref-enumeration-constant
  2219. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VIEWPORT_DIMENSIONS_X** = ``35``
  2220. Maximum viewport width (in pixels).
  2221. .. _class_RenderingDevice_constant_LIMIT_MAX_VIEWPORT_DIMENSIONS_Y:
  2222. .. rst-class:: classref-enumeration-constant
  2223. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VIEWPORT_DIMENSIONS_Y** = ``36``
  2224. Maximum viewport height (in pixels).
  2225. .. rst-class:: classref-item-separator
  2226. ----
  2227. .. _enum_RenderingDevice_MemoryType:
  2228. .. rst-class:: classref-enumeration
  2229. enum **MemoryType**:
  2230. .. _class_RenderingDevice_constant_MEMORY_TEXTURES:
  2231. .. rst-class:: classref-enumeration-constant
  2232. :ref:`MemoryType<enum_RenderingDevice_MemoryType>` **MEMORY_TEXTURES** = ``0``
  2233. Memory taken by textures.
  2234. .. _class_RenderingDevice_constant_MEMORY_BUFFERS:
  2235. .. rst-class:: classref-enumeration-constant
  2236. :ref:`MemoryType<enum_RenderingDevice_MemoryType>` **MEMORY_BUFFERS** = ``1``
  2237. Memory taken by buffers.
  2238. .. _class_RenderingDevice_constant_MEMORY_TOTAL:
  2239. .. rst-class:: classref-enumeration-constant
  2240. :ref:`MemoryType<enum_RenderingDevice_MemoryType>` **MEMORY_TOTAL** = ``2``
  2241. 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.
  2242. .. rst-class:: classref-section-separator
  2243. ----
  2244. .. rst-class:: classref-descriptions-group
  2245. Constants
  2246. ---------
  2247. .. _class_RenderingDevice_constant_INVALID_ID:
  2248. .. rst-class:: classref-constant
  2249. **INVALID_ID** = ``-1``
  2250. Returned by functions that return an ID if a value is invalid.
  2251. .. _class_RenderingDevice_constant_INVALID_FORMAT_ID:
  2252. .. rst-class:: classref-constant
  2253. **INVALID_FORMAT_ID** = ``-1``
  2254. Returned by functions that return a format ID if a value is invalid.
  2255. .. rst-class:: classref-section-separator
  2256. ----
  2257. .. rst-class:: classref-descriptions-group
  2258. Method Descriptions
  2259. -------------------
  2260. .. _class_RenderingDevice_method_barrier:
  2261. .. rst-class:: classref-method
  2262. void **barrier** **(** |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> from=32767, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> to=32767 **)**
  2263. Puts a memory barrier in place. This is used for synchronization to avoid data races. See also :ref:`full_barrier<class_RenderingDevice_method_full_barrier>`, which may be useful for debugging.
  2264. .. rst-class:: classref-item-separator
  2265. ----
  2266. .. _class_RenderingDevice_method_buffer_clear:
  2267. .. rst-class:: classref-method
  2268. :ref:`Error<enum_@GlobalScope_Error>` **buffer_clear** **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset, :ref:`int<class_int>` size_bytes, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)**
  2269. Clears the contents of the ``buffer``, clearing ``size_bytes`` bytes, starting at ``offset``. Always raises a memory barrier.
  2270. Prints an error if:
  2271. - the size isn't a multiple of four
  2272. - the region specified by ``offset`` + ``size_bytes`` exceeds the buffer
  2273. - a draw list is currently active (created by :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`)
  2274. - a compute list is currently active (created by :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>`)
  2275. .. rst-class:: classref-item-separator
  2276. ----
  2277. .. _class_RenderingDevice_method_buffer_get_data:
  2278. .. rst-class:: classref-method
  2279. :ref:`PackedByteArray<class_PackedByteArray>` **buffer_get_data** **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset_bytes=0, :ref:`int<class_int>` size_bytes=0 **)**
  2280. 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.
  2281. .. rst-class:: classref-item-separator
  2282. ----
  2283. .. _class_RenderingDevice_method_buffer_update:
  2284. .. rst-class:: classref-method
  2285. :ref:`Error<enum_@GlobalScope_Error>` **buffer_update** **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset, :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)**
  2286. Updates a region of ``size_bytes`` bytes, starting at ``offset``, in the buffer, with the specified ``data``. Raises a memory barrier except when ``post_barrier`` is set to :ref:`BARRIER_MASK_NO_BARRIER<class_RenderingDevice_constant_BARRIER_MASK_NO_BARRIER>`.
  2287. Prints an error if:
  2288. - the region specified by ``offset`` + ``size_bytes`` exceeds the buffer
  2289. - a draw list is currently active (created by :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`)
  2290. - a compute list is currently active (created by :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>`)
  2291. .. rst-class:: classref-item-separator
  2292. ----
  2293. .. _class_RenderingDevice_method_capture_timestamp:
  2294. .. rst-class:: classref-method
  2295. void **capture_timestamp** **(** :ref:`String<class_String>` name **)**
  2296. 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.
  2297. .. rst-class:: classref-item-separator
  2298. ----
  2299. .. _class_RenderingDevice_method_compute_list_add_barrier:
  2300. .. rst-class:: classref-method
  2301. void **compute_list_add_barrier** **(** :ref:`int<class_int>` compute_list **)**
  2302. Raises a Vulkan compute barrier in the specified ``compute_list``.
  2303. .. rst-class:: classref-item-separator
  2304. ----
  2305. .. _class_RenderingDevice_method_compute_list_begin:
  2306. .. rst-class:: classref-method
  2307. :ref:`int<class_int>` **compute_list_begin** **(** :ref:`bool<class_bool>` allow_draw_overlap=false **)**
  2308. Starts a list of compute commands created with the ``compute_*`` methods. The returned value should be passed to other ``compute_list_*`` functions.
  2309. If ``allow_draw_overlap`` is ``true``, you may have one draw list running at the same time as one compute list. 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>`.
  2310. A simple compute operation might look like this (code is not a complete example):
  2311. ::
  2312. var rd = RenderingDevice.new()
  2313. var compute_list = rd.compute_list_begin()
  2314. rd.compute_list_bind_compute_pipeline(compute_list, compute_shader_dilate_pipeline)
  2315. rd.compute_list_bind_uniform_set(compute_list, compute_base_uniform_set, 0)
  2316. rd.compute_list_bind_uniform_set(compute_list, dilate_uniform_set, 1)
  2317. for i in atlas_slices:
  2318. rd.compute_list_set_push_constant(compute_list, push_constant, push_constant.size())
  2319. rd.compute_list_dispatch(compute_list, group_size.x, group_size.y, group_size.z)
  2320. # No barrier, let them run all together.
  2321. rd.compute_list_end()
  2322. .. rst-class:: classref-item-separator
  2323. ----
  2324. .. _class_RenderingDevice_method_compute_list_bind_compute_pipeline:
  2325. .. rst-class:: classref-method
  2326. void **compute_list_bind_compute_pipeline** **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` compute_pipeline **)**
  2327. 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>`.
  2328. .. rst-class:: classref-item-separator
  2329. ----
  2330. .. _class_RenderingDevice_method_compute_list_bind_uniform_set:
  2331. .. rst-class:: classref-method
  2332. void **compute_list_bind_uniform_set** **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)**
  2333. 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.
  2334. .. rst-class:: classref-item-separator
  2335. ----
  2336. .. _class_RenderingDevice_method_compute_list_dispatch:
  2337. .. rst-class:: classref-method
  2338. void **compute_list_dispatch** **(** :ref:`int<class_int>` compute_list, :ref:`int<class_int>` x_groups, :ref:`int<class_int>` y_groups, :ref:`int<class_int>` z_groups **)**
  2339. 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>`.
  2340. .. rst-class:: classref-item-separator
  2341. ----
  2342. .. _class_RenderingDevice_method_compute_list_end:
  2343. .. rst-class:: classref-method
  2344. void **compute_list_end** **(** |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)**
  2345. Finishes a list of compute commands created with the ``compute_*`` methods.
  2346. .. rst-class:: classref-item-separator
  2347. ----
  2348. .. _class_RenderingDevice_method_compute_list_set_push_constant:
  2349. .. rst-class:: classref-method
  2350. void **compute_list_set_push_constant** **(** :ref:`int<class_int>` compute_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)**
  2351. 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``).
  2352. .. rst-class:: classref-item-separator
  2353. ----
  2354. .. _class_RenderingDevice_method_compute_pipeline_create:
  2355. .. rst-class:: classref-method
  2356. :ref:`RID<class_RID>` **compute_pipeline_create** **(** :ref:`RID<class_RID>` shader, :ref:`RDPipelineSpecializationConstant[]<class_RDPipelineSpecializationConstant>` specialization_constants=[] **)**
  2357. Creates a new compute pipeline. It can be accessed with the RID that is returned.
  2358. 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.
  2359. .. rst-class:: classref-item-separator
  2360. ----
  2361. .. _class_RenderingDevice_method_compute_pipeline_is_valid:
  2362. .. rst-class:: classref-method
  2363. :ref:`bool<class_bool>` **compute_pipeline_is_valid** **(** :ref:`RID<class_RID>` compute_pipeline **)**
  2364. Returns ``true`` if the compute pipeline specified by the ``compute_pipeline`` RID is valid, ``false`` otherwise.
  2365. .. rst-class:: classref-item-separator
  2366. ----
  2367. .. _class_RenderingDevice_method_create_local_device:
  2368. .. rst-class:: classref-method
  2369. :ref:`RenderingDevice<class_RenderingDevice>` **create_local_device** **(** **)**
  2370. Create a new local **RenderingDevice**. This is most useful for performing compute operations on the GPU independently from the rest of the engine.
  2371. .. rst-class:: classref-item-separator
  2372. ----
  2373. .. _class_RenderingDevice_method_draw_command_begin_label:
  2374. .. rst-class:: classref-method
  2375. void **draw_command_begin_label** **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)**
  2376. 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.
  2377. 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_insert_label<class_RenderingDevice_method_draw_command_insert_label>` and :ref:`draw_command_end_label<class_RenderingDevice_method_draw_command_end_label>`.
  2378. .. rst-class:: classref-item-separator
  2379. ----
  2380. .. _class_RenderingDevice_method_draw_command_end_label:
  2381. .. rst-class:: classref-method
  2382. void **draw_command_end_label** **(** **)**
  2383. Ends the command buffer debug label region started by a :ref:`draw_command_begin_label<class_RenderingDevice_method_draw_command_begin_label>` call.
  2384. .. rst-class:: classref-item-separator
  2385. ----
  2386. .. _class_RenderingDevice_method_draw_command_insert_label:
  2387. .. rst-class:: classref-method
  2388. void **draw_command_insert_label** **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)**
  2389. Inserts a command buffer debug label region in the current command buffer. Unlike :ref:`draw_command_begin_label<class_RenderingDevice_method_draw_command_begin_label>`, this region should not be ended with a :ref:`draw_command_end_label<class_RenderingDevice_method_draw_command_end_label>` call.
  2390. .. rst-class:: classref-item-separator
  2391. ----
  2392. .. _class_RenderingDevice_method_draw_list_begin:
  2393. .. rst-class:: classref-method
  2394. :ref:`int<class_int>` **draw_list_begin** **(** :ref:`RID<class_RID>` framebuffer, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_color_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_color_action, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_depth_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_depth_action, :ref:`PackedColorArray<class_PackedColorArray>` clear_color_values=PackedColorArray(), :ref:`float<class_float>` clear_depth=1.0, :ref:`int<class_int>` clear_stencil=0, :ref:`Rect2<class_Rect2>` region=Rect2(0, 0, 0, 0), :ref:`RID[]<class_RID>` storage_textures=[] **)**
  2395. Starts a list of raster drawing commands created with the ``draw_*`` methods. The returned value should be passed to other ``draw_list_*`` functions.
  2396. 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>`.
  2397. A simple drawing operation might look like this (code is not a complete example):
  2398. ::
  2399. var rd = RenderingDevice.new()
  2400. var clear_colors = PackedColorArray([Color(0, 0, 0, 0), Color(0, 0, 0, 0), Color(0, 0, 0, 0)]
  2401. var draw_list = rd.draw_list_begin(framebuffers[i], RenderingDevice.INITIAL_ACTION_CLEAR, RenderingDevice.FINAL_ACTION_READ, RenderingDevice.INITIAL_ACTION_CLEAR, RenderingDevice.FINAL_ACTION_DISCARD, clear_colors)
  2402. # Draw opaque.
  2403. rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline)
  2404. rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
  2405. rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
  2406. rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)
  2407. # Draw wire.
  2408. rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline_wire)
  2409. rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
  2410. rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
  2411. rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)
  2412. rd.draw_list_end()
  2413. .. rst-class:: classref-item-separator
  2414. ----
  2415. .. _class_RenderingDevice_method_draw_list_begin_for_screen:
  2416. .. rst-class:: classref-method
  2417. :ref:`int<class_int>` **draw_list_begin_for_screen** **(** :ref:`int<class_int>` screen=0, :ref:`Color<class_Color>` clear_color=Color(0, 0, 0, 1) **)**
  2418. 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.
  2419. \ **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>`.
  2420. .. rst-class:: classref-item-separator
  2421. ----
  2422. .. _class_RenderingDevice_method_draw_list_begin_split:
  2423. .. rst-class:: classref-method
  2424. :ref:`PackedInt64Array<class_PackedInt64Array>` **draw_list_begin_split** **(** :ref:`RID<class_RID>` framebuffer, :ref:`int<class_int>` splits, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_color_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_color_action, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_depth_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_depth_action, :ref:`PackedColorArray<class_PackedColorArray>` clear_color_values=PackedColorArray(), :ref:`float<class_float>` clear_depth=1.0, :ref:`int<class_int>` clear_stencil=0, :ref:`Rect2<class_Rect2>` region=Rect2(0, 0, 0, 0), :ref:`RID[]<class_RID>` storage_textures=[] **)**
  2425. Variant of :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>` with support for multiple splits. The ``splits`` parameter determines how many splits are created.
  2426. .. rst-class:: classref-item-separator
  2427. ----
  2428. .. _class_RenderingDevice_method_draw_list_bind_index_array:
  2429. .. rst-class:: classref-method
  2430. void **draw_list_bind_index_array** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` index_array **)**
  2431. Binds ``index_array`` to the specified ``draw_list``.
  2432. .. rst-class:: classref-item-separator
  2433. ----
  2434. .. _class_RenderingDevice_method_draw_list_bind_render_pipeline:
  2435. .. rst-class:: classref-method
  2436. void **draw_list_bind_render_pipeline** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` render_pipeline **)**
  2437. Binds ``render_pipeline`` to the specified ``draw_list``.
  2438. .. rst-class:: classref-item-separator
  2439. ----
  2440. .. _class_RenderingDevice_method_draw_list_bind_uniform_set:
  2441. .. rst-class:: classref-method
  2442. void **draw_list_bind_uniform_set** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)**
  2443. 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.
  2444. .. rst-class:: classref-item-separator
  2445. ----
  2446. .. _class_RenderingDevice_method_draw_list_bind_vertex_array:
  2447. .. rst-class:: classref-method
  2448. void **draw_list_bind_vertex_array** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` vertex_array **)**
  2449. Binds ``vertex_array`` to the specified ``draw_list``.
  2450. .. rst-class:: classref-item-separator
  2451. ----
  2452. .. _class_RenderingDevice_method_draw_list_disable_scissor:
  2453. .. rst-class:: classref-method
  2454. void **draw_list_disable_scissor** **(** :ref:`int<class_int>` draw_list **)**
  2455. 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>`.
  2456. .. rst-class:: classref-item-separator
  2457. ----
  2458. .. _class_RenderingDevice_method_draw_list_draw:
  2459. .. rst-class:: classref-method
  2460. void **draw_list_draw** **(** :ref:`int<class_int>` draw_list, :ref:`bool<class_bool>` use_indices, :ref:`int<class_int>` instances, :ref:`int<class_int>` procedural_vertex_count=0 **)**
  2461. Submits ``draw_list`` for rendering on the GPU. This is the raster equivalent to :ref:`compute_list_dispatch<class_RenderingDevice_method_compute_list_dispatch>`.
  2462. .. rst-class:: classref-item-separator
  2463. ----
  2464. .. _class_RenderingDevice_method_draw_list_enable_scissor:
  2465. .. rst-class:: classref-method
  2466. void **draw_list_enable_scissor** **(** :ref:`int<class_int>` draw_list, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)**
  2467. 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>`.
  2468. \ **Note:** The specified ``rect`` is automatically intersected with the screen's dimensions, which means it cannot exceed the screen's dimensions.
  2469. .. rst-class:: classref-item-separator
  2470. ----
  2471. .. _class_RenderingDevice_method_draw_list_end:
  2472. .. rst-class:: classref-method
  2473. void **draw_list_end** **(** |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)**
  2474. Finishes a list of raster drawing commands created with the ``draw_*`` methods.
  2475. .. rst-class:: classref-item-separator
  2476. ----
  2477. .. _class_RenderingDevice_method_draw_list_set_blend_constants:
  2478. .. rst-class:: classref-method
  2479. void **draw_list_set_blend_constants** **(** :ref:`int<class_int>` draw_list, :ref:`Color<class_Color>` color **)**
  2480. 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.
  2481. .. rst-class:: classref-item-separator
  2482. ----
  2483. .. _class_RenderingDevice_method_draw_list_set_push_constant:
  2484. .. rst-class:: classref-method
  2485. void **draw_list_set_push_constant** **(** :ref:`int<class_int>` draw_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)**
  2486. 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``).
  2487. .. rst-class:: classref-item-separator
  2488. ----
  2489. .. _class_RenderingDevice_method_draw_list_switch_to_next_pass:
  2490. .. rst-class:: classref-method
  2491. :ref:`int<class_int>` **draw_list_switch_to_next_pass** **(** **)**
  2492. Switches to the next draw pass and returns the split's ID. Equivalent to :ref:`draw_list_switch_to_next_pass_split<class_RenderingDevice_method_draw_list_switch_to_next_pass_split>` with ``splits`` set to ``1``.
  2493. .. rst-class:: classref-item-separator
  2494. ----
  2495. .. _class_RenderingDevice_method_draw_list_switch_to_next_pass_split:
  2496. .. rst-class:: classref-method
  2497. :ref:`PackedInt64Array<class_PackedInt64Array>` **draw_list_switch_to_next_pass_split** **(** :ref:`int<class_int>` splits **)**
  2498. Switches to the next draw pass, with the number of splits allocated specified in ``splits``. The return value is an array containing the ID of each split. For single-split usage, see :ref:`draw_list_switch_to_next_pass<class_RenderingDevice_method_draw_list_switch_to_next_pass>`.
  2499. .. rst-class:: classref-item-separator
  2500. ----
  2501. .. _class_RenderingDevice_method_framebuffer_create:
  2502. .. rst-class:: classref-method
  2503. :ref:`RID<class_RID>` **framebuffer_create** **(** :ref:`RID[]<class_RID>` textures, :ref:`int<class_int>` validate_with_format=-1, :ref:`int<class_int>` view_count=1 **)**
  2504. Creates a new framebuffer. It can be accessed with the RID that is returned.
  2505. 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.
  2506. .. rst-class:: classref-item-separator
  2507. ----
  2508. .. _class_RenderingDevice_method_framebuffer_create_empty:
  2509. .. rst-class:: classref-method
  2510. :ref:`RID<class_RID>` **framebuffer_create_empty** **(** :ref:`Vector2i<class_Vector2i>` size, :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples=0, :ref:`int<class_int>` validate_with_format=-1 **)**
  2511. Creates a new empty framebuffer. It can be accessed with the RID that is returned.
  2512. 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.
  2513. .. rst-class:: classref-item-separator
  2514. ----
  2515. .. _class_RenderingDevice_method_framebuffer_create_multipass:
  2516. .. rst-class:: classref-method
  2517. :ref:`RID<class_RID>` **framebuffer_create_multipass** **(** :ref:`RID[]<class_RID>` textures, :ref:`RDFramebufferPass[]<class_RDFramebufferPass>` passes, :ref:`int<class_int>` validate_with_format=-1, :ref:`int<class_int>` view_count=1 **)**
  2518. Creates a new multipass framebuffer. It can be accessed with the RID that is returned.
  2519. 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.
  2520. .. rst-class:: classref-item-separator
  2521. ----
  2522. .. _class_RenderingDevice_method_framebuffer_format_create:
  2523. .. rst-class:: classref-method
  2524. :ref:`int<class_int>` **framebuffer_format_create** **(** :ref:`RDAttachmentFormat[]<class_RDAttachmentFormat>` attachments, :ref:`int<class_int>` view_count=1 **)**
  2525. Creates a new framebuffer format with the specified ``attachments`` and ``view_count``. Returns the new framebuffer's unique framebuffer format ID.
  2526. 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.
  2527. .. rst-class:: classref-item-separator
  2528. ----
  2529. .. _class_RenderingDevice_method_framebuffer_format_create_empty:
  2530. .. rst-class:: classref-method
  2531. :ref:`int<class_int>` **framebuffer_format_create_empty** **(** :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples=0 **)**
  2532. Creates a new empty framebuffer format with the specified number of ``samples`` and returns its ID.
  2533. .. rst-class:: classref-item-separator
  2534. ----
  2535. .. _class_RenderingDevice_method_framebuffer_format_create_multipass:
  2536. .. rst-class:: classref-method
  2537. :ref:`int<class_int>` **framebuffer_format_create_multipass** **(** :ref:`RDAttachmentFormat[]<class_RDAttachmentFormat>` attachments, :ref:`RDFramebufferPass[]<class_RDFramebufferPass>` passes, :ref:`int<class_int>` view_count=1 **)**
  2538. 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.
  2539. .. rst-class:: classref-item-separator
  2540. ----
  2541. .. _class_RenderingDevice_method_framebuffer_format_get_texture_samples:
  2542. .. rst-class:: classref-method
  2543. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **framebuffer_format_get_texture_samples** **(** :ref:`int<class_int>` format, :ref:`int<class_int>` render_pass=0 **)**
  2544. 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>`).
  2545. .. rst-class:: classref-item-separator
  2546. ----
  2547. .. _class_RenderingDevice_method_framebuffer_get_format:
  2548. .. rst-class:: classref-method
  2549. :ref:`int<class_int>` **framebuffer_get_format** **(** :ref:`RID<class_RID>` framebuffer **)**
  2550. 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.
  2551. .. rst-class:: classref-item-separator
  2552. ----
  2553. .. _class_RenderingDevice_method_framebuffer_is_valid:
  2554. .. rst-class:: classref-method
  2555. :ref:`bool<class_bool>` **framebuffer_is_valid** **(** :ref:`RID<class_RID>` framebuffer **)** |const|
  2556. Returns ``true`` if the framebuffer specified by the ``framebuffer`` RID is valid, ``false`` otherwise.
  2557. .. rst-class:: classref-item-separator
  2558. ----
  2559. .. _class_RenderingDevice_method_free_rid:
  2560. .. rst-class:: classref-method
  2561. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  2562. 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.
  2563. .. rst-class:: classref-item-separator
  2564. ----
  2565. .. _class_RenderingDevice_method_full_barrier:
  2566. .. rst-class:: classref-method
  2567. void **full_barrier** **(** **)**
  2568. Puts a *full* memory barrier in place. This is a memory :ref:`barrier<class_RenderingDevice_method_barrier>` with all flags enabled. :ref:`full_barrier<class_RenderingDevice_method_full_barrier>` it should only be used for debugging as it can severely impact performance.
  2569. .. rst-class:: classref-item-separator
  2570. ----
  2571. .. _class_RenderingDevice_method_get_captured_timestamp_cpu_time:
  2572. .. rst-class:: classref-method
  2573. :ref:`int<class_int>` **get_captured_timestamp_cpu_time** **(** :ref:`int<class_int>` index **)** |const|
  2574. 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>`.
  2575. .. rst-class:: classref-item-separator
  2576. ----
  2577. .. _class_RenderingDevice_method_get_captured_timestamp_gpu_time:
  2578. .. rst-class:: classref-method
  2579. :ref:`int<class_int>` **get_captured_timestamp_gpu_time** **(** :ref:`int<class_int>` index **)** |const|
  2580. 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>`.
  2581. .. rst-class:: classref-item-separator
  2582. ----
  2583. .. _class_RenderingDevice_method_get_captured_timestamp_name:
  2584. .. rst-class:: classref-method
  2585. :ref:`String<class_String>` **get_captured_timestamp_name** **(** :ref:`int<class_int>` index **)** |const|
  2586. Returns the timestamp's name for the rendering step specified by ``index``. See also :ref:`capture_timestamp<class_RenderingDevice_method_capture_timestamp>`.
  2587. .. rst-class:: classref-item-separator
  2588. ----
  2589. .. _class_RenderingDevice_method_get_captured_timestamps_count:
  2590. .. rst-class:: classref-method
  2591. :ref:`int<class_int>` **get_captured_timestamps_count** **(** **)** |const|
  2592. Returns the total number of timestamps (rendering steps) available for profiling.
  2593. .. rst-class:: classref-item-separator
  2594. ----
  2595. .. _class_RenderingDevice_method_get_captured_timestamps_frame:
  2596. .. rst-class:: classref-method
  2597. :ref:`int<class_int>` **get_captured_timestamps_frame** **(** **)** |const|
  2598. Returns the index of the last frame rendered that has rendering timestamps available for querying.
  2599. .. rst-class:: classref-item-separator
  2600. ----
  2601. .. _class_RenderingDevice_method_get_device_name:
  2602. .. rst-class:: classref-method
  2603. :ref:`String<class_String>` **get_device_name** **(** **)** |const|
  2604. 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>`.
  2605. .. rst-class:: classref-item-separator
  2606. ----
  2607. .. _class_RenderingDevice_method_get_device_pipeline_cache_uuid:
  2608. .. rst-class:: classref-method
  2609. :ref:`String<class_String>` **get_device_pipeline_cache_uuid** **(** **)** |const|
  2610. 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.
  2611. .. rst-class:: classref-item-separator
  2612. ----
  2613. .. _class_RenderingDevice_method_get_device_vendor_name:
  2614. .. rst-class:: classref-method
  2615. :ref:`String<class_String>` **get_device_vendor_name** **(** **)** |const|
  2616. 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>`.
  2617. .. rst-class:: classref-item-separator
  2618. ----
  2619. .. _class_RenderingDevice_method_get_driver_resource:
  2620. .. rst-class:: classref-method
  2621. :ref:`int<class_int>` **get_driver_resource** **(** :ref:`DriverResource<enum_RenderingDevice_DriverResource>` resource, :ref:`RID<class_RID>` rid, :ref:`int<class_int>` index **)**
  2622. 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.
  2623. .. rst-class:: classref-item-separator
  2624. ----
  2625. .. _class_RenderingDevice_method_get_frame_delay:
  2626. .. rst-class:: classref-method
  2627. :ref:`int<class_int>` **get_frame_delay** **(** **)** |const|
  2628. 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.
  2629. .. rst-class:: classref-item-separator
  2630. ----
  2631. .. _class_RenderingDevice_method_get_memory_usage:
  2632. .. rst-class:: classref-method
  2633. :ref:`int<class_int>` **get_memory_usage** **(** :ref:`MemoryType<enum_RenderingDevice_MemoryType>` type **)** |const|
  2634. 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>`__.
  2635. .. rst-class:: classref-item-separator
  2636. ----
  2637. .. _class_RenderingDevice_method_index_array_create:
  2638. .. rst-class:: classref-method
  2639. :ref:`RID<class_RID>` **index_array_create** **(** :ref:`RID<class_RID>` index_buffer, :ref:`int<class_int>` index_offset, :ref:`int<class_int>` index_count **)**
  2640. Creates a new index array. It can be accessed with the RID that is returned.
  2641. 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.
  2642. .. rst-class:: classref-item-separator
  2643. ----
  2644. .. _class_RenderingDevice_method_index_buffer_create:
  2645. .. rst-class:: classref-method
  2646. :ref:`RID<class_RID>` **index_buffer_create** **(** :ref:`int<class_int>` size_indices, :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` format, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`bool<class_bool>` use_restart_indices=false **)**
  2647. Creates a new index buffer. It can be accessed with the RID that is returned.
  2648. 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.
  2649. .. rst-class:: classref-item-separator
  2650. ----
  2651. .. _class_RenderingDevice_method_limit_get:
  2652. .. rst-class:: classref-method
  2653. :ref:`int<class_int>` **limit_get** **(** :ref:`Limit<enum_RenderingDevice_Limit>` limit **)** |const|
  2654. 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.
  2655. Limits for various graphics hardware can be found in the `Vulkan Hardware Database <https://vulkan.gpuinfo.org/>`__.
  2656. .. rst-class:: classref-item-separator
  2657. ----
  2658. .. _class_RenderingDevice_method_render_pipeline_create:
  2659. .. rst-class:: classref-method
  2660. :ref:`RID<class_RID>` **render_pipeline_create** **(** :ref:`RID<class_RID>` shader, :ref:`int<class_int>` framebuffer_format, :ref:`int<class_int>` vertex_format, :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` primitive, :ref:`RDPipelineRasterizationState<class_RDPipelineRasterizationState>` rasterization_state, :ref:`RDPipelineMultisampleState<class_RDPipelineMultisampleState>` multisample_state, :ref:`RDPipelineDepthStencilState<class_RDPipelineDepthStencilState>` stencil_state, :ref:`RDPipelineColorBlendState<class_RDPipelineColorBlendState>` color_blend_state, |bitfield|\<:ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>`\> dynamic_state_flags=0, :ref:`int<class_int>` for_render_pass=0, :ref:`RDPipelineSpecializationConstant[]<class_RDPipelineSpecializationConstant>` specialization_constants=[] **)**
  2661. Creates a new render pipeline. It can be accessed with the RID that is returned.
  2662. 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.
  2663. .. rst-class:: classref-item-separator
  2664. ----
  2665. .. _class_RenderingDevice_method_render_pipeline_is_valid:
  2666. .. rst-class:: classref-method
  2667. :ref:`bool<class_bool>` **render_pipeline_is_valid** **(** :ref:`RID<class_RID>` render_pipeline **)**
  2668. Returns ``true`` if the render pipeline specified by the ``render_pipeline`` RID is valid, ``false`` otherwise.
  2669. .. rst-class:: classref-item-separator
  2670. ----
  2671. .. _class_RenderingDevice_method_sampler_create:
  2672. .. rst-class:: classref-method
  2673. :ref:`RID<class_RID>` **sampler_create** **(** :ref:`RDSamplerState<class_RDSamplerState>` state **)**
  2674. Creates a new sampler. It can be accessed with the RID that is returned.
  2675. 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.
  2676. .. rst-class:: classref-item-separator
  2677. ----
  2678. .. _class_RenderingDevice_method_sampler_is_format_supported_for_filter:
  2679. .. rst-class:: classref-method
  2680. :ref:`bool<class_bool>` **sampler_is_format_supported_for_filter** **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>` sampler_filter **)** |const|
  2681. Returns ``true`` if implementation supports using a texture of ``format`` with the given ``sampler_filter``.
  2682. .. rst-class:: classref-item-separator
  2683. ----
  2684. .. _class_RenderingDevice_method_screen_get_framebuffer_format:
  2685. .. rst-class:: classref-method
  2686. :ref:`int<class_int>` **screen_get_framebuffer_format** **(** **)** |const|
  2687. Returns the screen's framebuffer format.
  2688. \ **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>`.
  2689. .. rst-class:: classref-item-separator
  2690. ----
  2691. .. _class_RenderingDevice_method_screen_get_height:
  2692. .. rst-class:: classref-method
  2693. :ref:`int<class_int>` **screen_get_height** **(** :ref:`int<class_int>` screen=0 **)** |const|
  2694. 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>`.
  2695. \ **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>`.
  2696. .. rst-class:: classref-item-separator
  2697. ----
  2698. .. _class_RenderingDevice_method_screen_get_width:
  2699. .. rst-class:: classref-method
  2700. :ref:`int<class_int>` **screen_get_width** **(** :ref:`int<class_int>` screen=0 **)** |const|
  2701. 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>`.
  2702. \ **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>`.
  2703. .. rst-class:: classref-item-separator
  2704. ----
  2705. .. _class_RenderingDevice_method_set_resource_name:
  2706. .. rst-class:: classref-method
  2707. void **set_resource_name** **(** :ref:`RID<class_RID>` id, :ref:`String<class_String>` name **)**
  2708. Sets the resource name for ``id`` to ``name``. This is used for debugging with third-party tools such as `RenderDoc <https://renderdoc.org/>`__.
  2709. 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.
  2710. \ **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.
  2711. .. rst-class:: classref-item-separator
  2712. ----
  2713. .. _class_RenderingDevice_method_shader_compile_binary_from_spirv:
  2714. .. rst-class:: classref-method
  2715. :ref:`PackedByteArray<class_PackedByteArray>` **shader_compile_binary_from_spirv** **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)**
  2716. 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>`.
  2717. \ ``name`` is an optional human-readable name that can be given to the compiled shader for organizational purposes.
  2718. .. rst-class:: classref-item-separator
  2719. ----
  2720. .. _class_RenderingDevice_method_shader_compile_spirv_from_source:
  2721. .. rst-class:: classref-method
  2722. :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` **shader_compile_spirv_from_source** **(** :ref:`RDShaderSource<class_RDShaderSource>` shader_source, :ref:`bool<class_bool>` allow_cache=true **)**
  2723. 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>`.
  2724. 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.
  2725. .. rst-class:: classref-item-separator
  2726. ----
  2727. .. _class_RenderingDevice_method_shader_create_from_bytecode:
  2728. .. rst-class:: classref-method
  2729. :ref:`RID<class_RID>` **shader_create_from_bytecode** **(** :ref:`PackedByteArray<class_PackedByteArray>` binary_data, :ref:`RID<class_RID>` placeholder_rid=RID() **)**
  2730. Creates a new shader instance from a binary compiled shader. It can be accessed with the RID that is returned.
  2731. 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>`.
  2732. .. rst-class:: classref-item-separator
  2733. ----
  2734. .. _class_RenderingDevice_method_shader_create_from_spirv:
  2735. .. rst-class:: classref-method
  2736. :ref:`RID<class_RID>` **shader_create_from_spirv** **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)**
  2737. Creates a new shader instance from SPIR-V intermediate code. It can be accessed with the RID that is returned.
  2738. 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>`.
  2739. .. rst-class:: classref-item-separator
  2740. ----
  2741. .. _class_RenderingDevice_method_shader_create_placeholder:
  2742. .. rst-class:: classref-method
  2743. :ref:`RID<class_RID>` **shader_create_placeholder** **(** **)**
  2744. 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.
  2745. .. rst-class:: classref-item-separator
  2746. ----
  2747. .. _class_RenderingDevice_method_shader_get_vertex_input_attribute_mask:
  2748. .. rst-class:: classref-method
  2749. :ref:`int<class_int>` **shader_get_vertex_input_attribute_mask** **(** :ref:`RID<class_RID>` shader **)**
  2750. 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).
  2751. .. rst-class:: classref-item-separator
  2752. ----
  2753. .. _class_RenderingDevice_method_storage_buffer_create:
  2754. .. rst-class:: classref-method
  2755. :ref:`RID<class_RID>` **storage_buffer_create** **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), |bitfield|\<:ref:`StorageBufferUsage<enum_RenderingDevice_StorageBufferUsage>`\> usage=0 **)**
  2756. 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.
  2757. 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.
  2758. .. rst-class:: classref-item-separator
  2759. ----
  2760. .. _class_RenderingDevice_method_submit:
  2761. .. rst-class:: classref-method
  2762. void **submit** **(** **)**
  2763. 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>`).
  2764. \ **Note:** Only available in local RenderingDevices.
  2765. .. rst-class:: classref-item-separator
  2766. ----
  2767. .. _class_RenderingDevice_method_sync:
  2768. .. rst-class:: classref-method
  2769. void **sync** **(** **)**
  2770. 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.
  2771. \ **Note:** Only available in local RenderingDevices.
  2772. \ **Note:** :ref:`sync<class_RenderingDevice_method_sync>` can only be called after a :ref:`submit<class_RenderingDevice_method_submit>`.
  2773. .. rst-class:: classref-item-separator
  2774. ----
  2775. .. _class_RenderingDevice_method_texture_buffer_create:
  2776. .. rst-class:: classref-method
  2777. :ref:`RID<class_RID>` **texture_buffer_create** **(** :ref:`int<class_int>` size_bytes, :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray() **)**
  2778. Creates a new texture buffer. It can be accessed with the RID that is returned.
  2779. 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.
  2780. .. rst-class:: classref-item-separator
  2781. ----
  2782. .. _class_RenderingDevice_method_texture_clear:
  2783. .. rst-class:: classref-method
  2784. :ref:`Error<enum_@GlobalScope_Error>` **texture_clear** **(** :ref:`RID<class_RID>` texture, :ref:`Color<class_Color>` color, :ref:`int<class_int>` base_mipmap, :ref:`int<class_int>` mipmap_count, :ref:`int<class_int>` base_layer, :ref:`int<class_int>` layer_count, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)**
  2785. 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``.
  2786. \ **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.
  2787. .. rst-class:: classref-item-separator
  2788. ----
  2789. .. _class_RenderingDevice_method_texture_copy:
  2790. .. rst-class:: classref-method
  2791. :ref:`Error<enum_@GlobalScope_Error>` **texture_copy** **(** :ref:`RID<class_RID>` from_texture, :ref:`RID<class_RID>` to_texture, :ref:`Vector3<class_Vector3>` from_pos, :ref:`Vector3<class_Vector3>` to_pos, :ref:`Vector3<class_Vector3>` size, :ref:`int<class_int>` src_mipmap, :ref:`int<class_int>` dst_mipmap, :ref:`int<class_int>` src_layer, :ref:`int<class_int>` dst_layer, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)**
  2792. 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.
  2793. \ **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.
  2794. \ **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.
  2795. \ **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.
  2796. \ **Note:** ``to_texture`` requires the :ref:`TEXTURE_USAGE_CAN_COPY_TO_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_TO_BIT>` to be retrieved.
  2797. \ **Note:** ``from_texture`` and ``to_texture`` must be of the same type (color or depth).
  2798. .. rst-class:: classref-item-separator
  2799. ----
  2800. .. _class_RenderingDevice_method_texture_create:
  2801. .. rst-class:: classref-method
  2802. :ref:`RID<class_RID>` **texture_create** **(** :ref:`RDTextureFormat<class_RDTextureFormat>` format, :ref:`RDTextureView<class_RDTextureView>` view, :ref:`PackedByteArray[]<class_PackedByteArray>` data=[] **)**
  2803. Creates a new texture. It can be accessed with the RID that is returned.
  2804. 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.
  2805. \ **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.
  2806. .. rst-class:: classref-item-separator
  2807. ----
  2808. .. _class_RenderingDevice_method_texture_create_from_extension:
  2809. .. rst-class:: classref-method
  2810. :ref:`RID<class_RID>` **texture_create_from_extension** **(** :ref:`TextureType<enum_RenderingDevice_TextureType>` type, :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples, |bitfield|\<:ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>`\> usage_flags, :ref:`int<class_int>` image, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` depth, :ref:`int<class_int>` layers **)**
  2811. 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.
  2812. .. rst-class:: classref-item-separator
  2813. ----
  2814. .. _class_RenderingDevice_method_texture_create_shared:
  2815. .. rst-class:: classref-method
  2816. :ref:`RID<class_RID>` **texture_create_shared** **(** :ref:`RDTextureView<class_RDTextureView>` view, :ref:`RID<class_RID>` with_texture **)**
  2817. Creates a shared texture using the specified ``view`` and the texture information from ``with_texture``.
  2818. .. rst-class:: classref-item-separator
  2819. ----
  2820. .. _class_RenderingDevice_method_texture_create_shared_from_slice:
  2821. .. rst-class:: classref-method
  2822. :ref:`RID<class_RID>` **texture_create_shared_from_slice** **(** :ref:`RDTextureView<class_RDTextureView>` view, :ref:`RID<class_RID>` with_texture, :ref:`int<class_int>` layer, :ref:`int<class_int>` mipmap, :ref:`int<class_int>` mipmaps=1, :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` slice_type=0 **)**
  2823. 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>`\
  2824. For 2D textures (which only have one layer), ``layer`` must be ``0``.
  2825. \ **Note:** Layer slicing is only supported for 2D texture arrays, not 3D textures or cubemaps.
  2826. .. rst-class:: classref-item-separator
  2827. ----
  2828. .. _class_RenderingDevice_method_texture_get_data:
  2829. .. rst-class:: classref-method
  2830. :ref:`PackedByteArray<class_PackedByteArray>` **texture_get_data** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)**
  2831. Returns the ``texture`` data for the specified ``layer`` as raw binary data. For 2D textures (which only have one layer), ``layer`` must be ``0``.
  2832. \ **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.
  2833. \ **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.
  2834. .. rst-class:: classref-item-separator
  2835. ----
  2836. .. _class_RenderingDevice_method_texture_get_format:
  2837. .. rst-class:: classref-method
  2838. :ref:`RDTextureFormat<class_RDTextureFormat>` **texture_get_format** **(** :ref:`RID<class_RID>` texture **)**
  2839. Returns the data format used to create this texture.
  2840. .. rst-class:: classref-item-separator
  2841. ----
  2842. .. _class_RenderingDevice_method_texture_get_native_handle:
  2843. .. rst-class:: classref-method
  2844. :ref:`int<class_int>` **texture_get_native_handle** **(** :ref:`RID<class_RID>` texture **)**
  2845. Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
  2846. \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan).
  2847. .. rst-class:: classref-item-separator
  2848. ----
  2849. .. _class_RenderingDevice_method_texture_is_format_supported_for_usage:
  2850. .. rst-class:: classref-method
  2851. :ref:`bool<class_bool>` **texture_is_format_supported_for_usage** **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, |bitfield|\<:ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>`\> usage_flags **)** |const|
  2852. Returns ``true`` if the specified ``format`` is supported for the given ``usage_flags``, ``false`` otherwise.
  2853. .. rst-class:: classref-item-separator
  2854. ----
  2855. .. _class_RenderingDevice_method_texture_is_shared:
  2856. .. rst-class:: classref-method
  2857. :ref:`bool<class_bool>` **texture_is_shared** **(** :ref:`RID<class_RID>` texture **)**
  2858. Returns ``true`` if the ``texture`` is shared, ``false`` otherwise. See :ref:`RDTextureView<class_RDTextureView>`.
  2859. .. rst-class:: classref-item-separator
  2860. ----
  2861. .. _class_RenderingDevice_method_texture_is_valid:
  2862. .. rst-class:: classref-method
  2863. :ref:`bool<class_bool>` **texture_is_valid** **(** :ref:`RID<class_RID>` texture **)**
  2864. Returns ``true`` if the ``texture`` is valid, ``false`` otherwise.
  2865. .. rst-class:: classref-item-separator
  2866. ----
  2867. .. _class_RenderingDevice_method_texture_resolve_multisample:
  2868. .. rst-class:: classref-method
  2869. :ref:`Error<enum_@GlobalScope_Error>` **texture_resolve_multisample** **(** :ref:`RID<class_RID>` from_texture, :ref:`RID<class_RID>` to_texture, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)**
  2870. 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.
  2871. \ **Note:** ``from_texture`` and ``to_texture`` textures must have the same dimension, format and type (color or depth).
  2872. \ **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.
  2873. \ **Note:** ``from_texture`` requires the :ref:`TEXTURE_USAGE_CAN_COPY_FROM_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT>` to be retrieved.
  2874. \ **Note:** ``from_texture`` must be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
  2875. \ **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.
  2876. \ **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.
  2877. \ **Note:** ``to_texture`` texture must **not** be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
  2878. .. rst-class:: classref-item-separator
  2879. ----
  2880. .. _class_RenderingDevice_method_texture_update:
  2881. .. rst-class:: classref-method
  2882. :ref:`Error<enum_@GlobalScope_Error>` **texture_update** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer, :ref:`PackedByteArray<class_PackedByteArray>` data, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=32767 **)**
  2883. 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.
  2884. \ **Note:** Updating textures is forbidden during creation of a draw or compute list.
  2885. \ **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.
  2886. \ **Note:** The existing ``texture`` requires the :ref:`TEXTURE_USAGE_CAN_UPDATE_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_UPDATE_BIT>` to be updatable.
  2887. .. rst-class:: classref-item-separator
  2888. ----
  2889. .. _class_RenderingDevice_method_uniform_buffer_create:
  2890. .. rst-class:: classref-method
  2891. :ref:`RID<class_RID>` **uniform_buffer_create** **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray() **)**
  2892. Creates a new uniform buffer. It can be accessed with the RID that is returned.
  2893. 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.
  2894. .. rst-class:: classref-item-separator
  2895. ----
  2896. .. _class_RenderingDevice_method_uniform_set_create:
  2897. .. rst-class:: classref-method
  2898. :ref:`RID<class_RID>` **uniform_set_create** **(** :ref:`RDUniform[]<class_RDUniform>` uniforms, :ref:`RID<class_RID>` shader, :ref:`int<class_int>` shader_set **)**
  2899. Creates a new uniform set. It can be accessed with the RID that is returned.
  2900. 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.
  2901. .. rst-class:: classref-item-separator
  2902. ----
  2903. .. _class_RenderingDevice_method_uniform_set_is_valid:
  2904. .. rst-class:: classref-method
  2905. :ref:`bool<class_bool>` **uniform_set_is_valid** **(** :ref:`RID<class_RID>` uniform_set **)**
  2906. Checks if the ``uniform_set`` is valid, i.e. is owned.
  2907. .. rst-class:: classref-item-separator
  2908. ----
  2909. .. _class_RenderingDevice_method_vertex_array_create:
  2910. .. rst-class:: classref-method
  2911. :ref:`RID<class_RID>` **vertex_array_create** **(** :ref:`int<class_int>` vertex_count, :ref:`int<class_int>` vertex_format, :ref:`RID[]<class_RID>` src_buffers, :ref:`PackedInt64Array<class_PackedInt64Array>` offsets=PackedInt64Array() **)**
  2912. Creates a vertex array based on the specified buffers. Optionally, ``offsets`` (in bytes) may be defined for each buffer.
  2913. .. rst-class:: classref-item-separator
  2914. ----
  2915. .. _class_RenderingDevice_method_vertex_buffer_create:
  2916. .. rst-class:: classref-method
  2917. :ref:`RID<class_RID>` **vertex_buffer_create** **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`bool<class_bool>` use_as_storage=false **)**
  2918. It can be accessed with the RID that is returned.
  2919. 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.
  2920. .. rst-class:: classref-item-separator
  2921. ----
  2922. .. _class_RenderingDevice_method_vertex_format_create:
  2923. .. rst-class:: classref-method
  2924. :ref:`int<class_int>` **vertex_format_create** **(** :ref:`RDVertexAttribute[]<class_RDVertexAttribute>` vertex_descriptions **)**
  2925. Creates a new vertex format with the specified ``vertex_descriptions``. Returns a unique vertex format ID corresponding to the newly created vertex format.
  2926. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2927. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2928. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2929. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2930. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2931. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2932. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`