class_renderingdevice.rst 402 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595
  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/4.1/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.1/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=7, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> to=7 **)** |
  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=7 **)** |
  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=7 **)** |
  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=7 **)** |
  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=7 **)** |
  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 **)** |
  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:`int<class_int>` | :ref:`shader_get_vertex_input_attribute_mask<class_RenderingDevice_method_shader_get_vertex_input_attribute_mask>` **(** :ref:`RID<class_RID>` shader **)** |
  170. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | :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 **)** |
  172. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | void | :ref:`submit<class_RenderingDevice_method_submit>` **(** **)** |
  174. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | void | :ref:`sync<class_RenderingDevice_method_sync>` **(** **)** |
  176. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | :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() **)** |
  178. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | :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=7 **)** |
  180. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | :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=7 **)** |
  182. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | :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=[] **)** |
  184. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | :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 **)** |
  186. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :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 **)** |
  188. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`texture_get_data<class_RenderingDevice_method_texture_get_data>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |
  190. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`int<class_int>` | :ref:`texture_get_native_handle<class_RenderingDevice_method_texture_get_native_handle>` **(** :ref:`RID<class_RID>` texture **)** |
  192. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | :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| |
  194. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | :ref:`bool<class_bool>` | :ref:`texture_is_shared<class_RenderingDevice_method_texture_is_shared>` **(** :ref:`RID<class_RID>` texture **)** |
  196. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | :ref:`bool<class_bool>` | :ref:`texture_is_valid<class_RenderingDevice_method_texture_is_valid>` **(** :ref:`RID<class_RID>` texture **)** |
  198. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | :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=7 **)** |
  200. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | :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=7 **)** |
  202. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :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() **)** |
  204. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | :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 **)** |
  206. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | :ref:`bool<class_bool>` | :ref:`uniform_set_is_valid<class_RenderingDevice_method_uniform_set_is_valid>` **(** :ref:`RID<class_RID>` uniform_set **)** |
  208. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | :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() **)** |
  210. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | :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 **)** |
  212. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | :ref:`int<class_int>` | :ref:`vertex_format_create<class_RenderingDevice_method_vertex_format_create>` **(** :ref:`RDVertexAttribute[]<class_RDVertexAttribute>` vertex_descriptions **)** |
  214. +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. .. rst-class:: classref-section-separator
  216. ----
  217. .. rst-class:: classref-descriptions-group
  218. Enumerations
  219. ------------
  220. .. _enum_RenderingDevice_DeviceType:
  221. .. rst-class:: classref-enumeration
  222. enum **DeviceType**:
  223. .. _class_RenderingDevice_constant_DEVICE_TYPE_OTHER:
  224. .. rst-class:: classref-enumeration-constant
  225. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_OTHER** = ``0``
  226. Rendering device type does not match any of the other enum values or is unknown.
  227. .. _class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU:
  228. .. rst-class:: classref-enumeration-constant
  229. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_INTEGRATED_GPU** = ``1``
  230. 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>`.
  231. .. _class_RenderingDevice_constant_DEVICE_TYPE_DISCRETE_GPU:
  232. .. rst-class:: classref-enumeration-constant
  233. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_DISCRETE_GPU** = ``2``
  234. 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>`).
  235. .. _class_RenderingDevice_constant_DEVICE_TYPE_VIRTUAL_GPU:
  236. .. rst-class:: classref-enumeration-constant
  237. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_VIRTUAL_GPU** = ``3``
  238. 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.
  239. .. _class_RenderingDevice_constant_DEVICE_TYPE_CPU:
  240. .. rst-class:: classref-enumeration-constant
  241. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_CPU** = ``4``
  242. 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>`.
  243. .. _class_RenderingDevice_constant_DEVICE_TYPE_MAX:
  244. .. rst-class:: classref-enumeration-constant
  245. :ref:`DeviceType<enum_RenderingDevice_DeviceType>` **DEVICE_TYPE_MAX** = ``5``
  246. Represents the size of the :ref:`DeviceType<enum_RenderingDevice_DeviceType>` enum.
  247. .. rst-class:: classref-item-separator
  248. ----
  249. .. _enum_RenderingDevice_DriverResource:
  250. .. rst-class:: classref-enumeration
  251. enum **DriverResource**:
  252. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DEVICE:
  253. .. rst-class:: classref-enumeration-constant
  254. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_DEVICE** = ``0``
  255. Vulkan device driver resource. This is a "global" resource and ignores the RID passed in
  256. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE:
  257. .. rst-class:: classref-enumeration-constant
  258. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE** = ``1``
  259. Physical device (graphics card) driver resource.
  260. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_INSTANCE:
  261. .. rst-class:: classref-enumeration-constant
  262. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_INSTANCE** = ``2``
  263. Vulkan instance driver resource.
  264. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE:
  265. .. rst-class:: classref-enumeration-constant
  266. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_QUEUE** = ``3``
  267. Vulkan queue driver resource.
  268. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX:
  269. .. rst-class:: classref-enumeration-constant
  270. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX** = ``4``
  271. Vulkan queue family index driver resource.
  272. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE:
  273. .. rst-class:: classref-enumeration-constant
  274. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_IMAGE** = ``5``
  275. Vulkan image driver resource.
  276. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_VIEW:
  277. .. rst-class:: classref-enumeration-constant
  278. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_IMAGE_VIEW** = ``6``
  279. Vulkan image view driver resource.
  280. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT:
  281. .. rst-class:: classref-enumeration-constant
  282. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT** = ``7``
  283. Vulkan image native texture format driver resource.
  284. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_SAMPLER:
  285. .. rst-class:: classref-enumeration-constant
  286. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_SAMPLER** = ``8``
  287. Vulkan sampler driver resource.
  288. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET:
  289. .. rst-class:: classref-enumeration-constant
  290. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET** = ``9``
  291. Vulkan `descriptor set <https://vkguide.dev/docs/chapter-4/descriptors/>`__ driver resource.
  292. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_BUFFER:
  293. .. rst-class:: classref-enumeration-constant
  294. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_BUFFER** = ``10``
  295. Vulkan buffer driver resource.
  296. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE:
  297. .. rst-class:: classref-enumeration-constant
  298. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE** = ``11``
  299. Vulkan compute pipeline driver resource.
  300. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE:
  301. .. rst-class:: classref-enumeration-constant
  302. :ref:`DriverResource<enum_RenderingDevice_DriverResource>` **DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE** = ``12``
  303. Vulkan render pipeline driver resource.
  304. .. rst-class:: classref-item-separator
  305. ----
  306. .. _enum_RenderingDevice_DataFormat:
  307. .. rst-class:: classref-enumeration
  308. enum **DataFormat**:
  309. .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4_UNORM_PACK8:
  310. .. rst-class:: classref-enumeration-constant
  311. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R4G4_UNORM_PACK8** = ``0``
  312. 4-bit-per-channel red/green channel data format, packed into 8 bits. Values are in the ``[0.0, 1.0]`` range.
  313. \ **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.
  314. .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4B4A4_UNORM_PACK16:
  315. .. rst-class:: classref-enumeration-constant
  316. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R4G4B4A4_UNORM_PACK16** = ``1``
  317. 4-bit-per-channel red/green/blue/alpha channel data format, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  318. .. _class_RenderingDevice_constant_DATA_FORMAT_B4G4R4A4_UNORM_PACK16:
  319. .. rst-class:: classref-enumeration-constant
  320. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B4G4R4A4_UNORM_PACK16** = ``2``
  321. 4-bit-per-channel blue/green/red/alpha channel data format, packed into 16 bits. Values are in the ``[0.0, 1.0]`` range.
  322. .. _class_RenderingDevice_constant_DATA_FORMAT_R5G6B5_UNORM_PACK16:
  323. .. rst-class:: classref-enumeration-constant
  324. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R5G6B5_UNORM_PACK16** = ``3``
  325. 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.
  326. .. _class_RenderingDevice_constant_DATA_FORMAT_B5G6R5_UNORM_PACK16:
  327. .. rst-class:: classref-enumeration-constant
  328. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B5G6R5_UNORM_PACK16** = ``4``
  329. 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.
  330. .. _class_RenderingDevice_constant_DATA_FORMAT_R5G5B5A1_UNORM_PACK16:
  331. .. rst-class:: classref-enumeration-constant
  332. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R5G5B5A1_UNORM_PACK16** = ``5``
  333. 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.
  334. .. _class_RenderingDevice_constant_DATA_FORMAT_B5G5R5A1_UNORM_PACK16:
  335. .. rst-class:: classref-enumeration-constant
  336. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B5G5R5A1_UNORM_PACK16** = ``6``
  337. 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.
  338. .. _class_RenderingDevice_constant_DATA_FORMAT_A1R5G5B5_UNORM_PACK16:
  339. .. rst-class:: classref-enumeration-constant
  340. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A1R5G5B5_UNORM_PACK16** = ``7``
  341. 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.
  342. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UNORM:
  343. .. rst-class:: classref-enumeration-constant
  344. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_UNORM** = ``8``
  345. 8-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  346. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SNORM:
  347. .. rst-class:: classref-enumeration-constant
  348. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SNORM** = ``9``
  349. 8-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  350. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_USCALED:
  351. .. rst-class:: classref-enumeration-constant
  352. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_USCALED** = ``10``
  353. 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.
  354. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SSCALED:
  355. .. rst-class:: classref-enumeration-constant
  356. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SSCALED** = ``11``
  357. 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.
  358. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UINT:
  359. .. rst-class:: classref-enumeration-constant
  360. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_UINT** = ``12``
  361. 8-bit-per-channel unsigned integer red channel data format. Values are in the ``[0, 255]`` range.
  362. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SINT:
  363. .. rst-class:: classref-enumeration-constant
  364. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SINT** = ``13``
  365. 8-bit-per-channel signed integer red channel data format. Values are in the ``[-127, 127]`` range.
  366. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SRGB:
  367. .. rst-class:: classref-enumeration-constant
  368. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8_SRGB** = ``14``
  369. 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.
  370. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UNORM:
  371. .. rst-class:: classref-enumeration-constant
  372. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_UNORM** = ``15``
  373. 8-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  374. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SNORM:
  375. .. rst-class:: classref-enumeration-constant
  376. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SNORM** = ``16``
  377. 8-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  378. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_USCALED:
  379. .. rst-class:: classref-enumeration-constant
  380. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_USCALED** = ``17``
  381. 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.
  382. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SSCALED:
  383. .. rst-class:: classref-enumeration-constant
  384. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SSCALED** = ``18``
  385. 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.
  386. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UINT:
  387. .. rst-class:: classref-enumeration-constant
  388. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_UINT** = ``19``
  389. 8-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0, 255]`` range.
  390. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SINT:
  391. .. rst-class:: classref-enumeration-constant
  392. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SINT** = ``20``
  393. 8-bit-per-channel signed integer red/green channel data format. Values are in the ``[-127, 127]`` range.
  394. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SRGB:
  395. .. rst-class:: classref-enumeration-constant
  396. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8_SRGB** = ``21``
  397. 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.
  398. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UNORM:
  399. .. rst-class:: classref-enumeration-constant
  400. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_UNORM** = ``22``
  401. 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.
  402. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SNORM:
  403. .. rst-class:: classref-enumeration-constant
  404. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SNORM** = ``23``
  405. 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.
  406. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_USCALED:
  407. .. rst-class:: classref-enumeration-constant
  408. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_USCALED** = ``24``
  409. 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.
  410. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SSCALED:
  411. .. rst-class:: classref-enumeration-constant
  412. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SSCALED** = ``25``
  413. 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.
  414. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UINT:
  415. .. rst-class:: classref-enumeration-constant
  416. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_UINT** = ``26``
  417. 8-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0, 255]`` range.
  418. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SINT:
  419. .. rst-class:: classref-enumeration-constant
  420. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SINT** = ``27``
  421. 8-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[-127, 127]`` range.
  422. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SRGB:
  423. .. rst-class:: classref-enumeration-constant
  424. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8_SRGB** = ``28``
  425. 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.
  426. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UNORM:
  427. .. rst-class:: classref-enumeration-constant
  428. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_UNORM** = ``29``
  429. 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.
  430. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SNORM:
  431. .. rst-class:: classref-enumeration-constant
  432. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SNORM** = ``30``
  433. 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.
  434. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_USCALED:
  435. .. rst-class:: classref-enumeration-constant
  436. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_USCALED** = ``31``
  437. 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.
  438. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SSCALED:
  439. .. rst-class:: classref-enumeration-constant
  440. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SSCALED** = ``32``
  441. 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.
  442. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UINT:
  443. .. rst-class:: classref-enumeration-constant
  444. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_UINT** = ``33``
  445. 8-bit-per-channel unsigned integer blue/green/red channel data format. Values are in the ``[0, 255]`` range.
  446. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SINT:
  447. .. rst-class:: classref-enumeration-constant
  448. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SINT** = ``34``
  449. 8-bit-per-channel signed integer blue/green/red channel data format. Values are in the ``[-127, 127]`` range.
  450. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SRGB:
  451. .. rst-class:: classref-enumeration-constant
  452. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8_SRGB** = ``35``
  453. 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.
  454. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UNORM:
  455. .. rst-class:: classref-enumeration-constant
  456. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_UNORM** = ``36``
  457. 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.
  458. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SNORM:
  459. .. rst-class:: classref-enumeration-constant
  460. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SNORM** = ``37``
  461. 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.
  462. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_USCALED:
  463. .. rst-class:: classref-enumeration-constant
  464. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_USCALED** = ``38``
  465. 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.
  466. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SSCALED:
  467. .. rst-class:: classref-enumeration-constant
  468. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SSCALED** = ``39``
  469. 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.
  470. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UINT:
  471. .. rst-class:: classref-enumeration-constant
  472. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_UINT** = ``40``
  473. 8-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0, 255]`` range.
  474. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SINT:
  475. .. rst-class:: classref-enumeration-constant
  476. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SINT** = ``41``
  477. 8-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[-127, 127]`` range.
  478. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SRGB:
  479. .. rst-class:: classref-enumeration-constant
  480. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R8G8B8A8_SRGB** = ``42``
  481. 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.
  482. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UNORM:
  483. .. rst-class:: classref-enumeration-constant
  484. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_UNORM** = ``43``
  485. 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.
  486. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SNORM:
  487. .. rst-class:: classref-enumeration-constant
  488. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SNORM** = ``44``
  489. 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.
  490. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_USCALED:
  491. .. rst-class:: classref-enumeration-constant
  492. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_USCALED** = ``45``
  493. 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.
  494. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SSCALED:
  495. .. rst-class:: classref-enumeration-constant
  496. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SSCALED** = ``46``
  497. 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.
  498. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UINT:
  499. .. rst-class:: classref-enumeration-constant
  500. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_UINT** = ``47``
  501. 8-bit-per-channel unsigned integer blue/green/red/alpha channel data format. Values are in the ``[0, 255]`` range.
  502. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SINT:
  503. .. rst-class:: classref-enumeration-constant
  504. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SINT** = ``48``
  505. 8-bit-per-channel signed integer blue/green/red/alpha channel data format. Values are in the ``[-127, 127]`` range.
  506. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SRGB:
  507. .. rst-class:: classref-enumeration-constant
  508. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8A8_SRGB** = ``49``
  509. 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.
  510. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UNORM_PACK32:
  511. .. rst-class:: classref-enumeration-constant
  512. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_UNORM_PACK32** = ``50``
  513. 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.
  514. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SNORM_PACK32:
  515. .. rst-class:: classref-enumeration-constant
  516. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SNORM_PACK32** = ``51``
  517. 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.
  518. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_USCALED_PACK32:
  519. .. rst-class:: classref-enumeration-constant
  520. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_USCALED_PACK32** = ``52``
  521. 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.
  522. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SSCALED_PACK32:
  523. .. rst-class:: classref-enumeration-constant
  524. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SSCALED_PACK32** = ``53``
  525. 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.
  526. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UINT_PACK32:
  527. .. rst-class:: classref-enumeration-constant
  528. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_UINT_PACK32** = ``54``
  529. 8-bit-per-channel unsigned integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the ``[0, 255]`` range.
  530. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SINT_PACK32:
  531. .. rst-class:: classref-enumeration-constant
  532. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SINT_PACK32** = ``55``
  533. 8-bit-per-channel signed integer alpha/red/green/blue channel data format, packed in 32 bits. Values are in the ``[-127, 127]`` range.
  534. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SRGB_PACK32:
  535. .. rst-class:: classref-enumeration-constant
  536. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A8B8G8R8_SRGB_PACK32** = ``56``
  537. 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.
  538. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UNORM_PACK32:
  539. .. rst-class:: classref-enumeration-constant
  540. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_UNORM_PACK32** = ``57``
  541. 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.
  542. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SNORM_PACK32:
  543. .. rst-class:: classref-enumeration-constant
  544. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_SNORM_PACK32** = ``58``
  545. 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.
  546. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_USCALED_PACK32:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_USCALED_PACK32** = ``59``
  549. 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.
  550. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SSCALED_PACK32:
  551. .. rst-class:: classref-enumeration-constant
  552. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_SSCALED_PACK32** = ``60``
  553. 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.
  554. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UINT_PACK32:
  555. .. rst-class:: classref-enumeration-constant
  556. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_UINT_PACK32** = ``61``
  557. 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.
  558. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SINT_PACK32:
  559. .. rst-class:: classref-enumeration-constant
  560. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2R10G10B10_SINT_PACK32** = ``62``
  561. 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.
  562. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UNORM_PACK32:
  563. .. rst-class:: classref-enumeration-constant
  564. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_UNORM_PACK32** = ``63``
  565. 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.
  566. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SNORM_PACK32:
  567. .. rst-class:: classref-enumeration-constant
  568. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_SNORM_PACK32** = ``64``
  569. 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.
  570. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_USCALED_PACK32:
  571. .. rst-class:: classref-enumeration-constant
  572. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_USCALED_PACK32** = ``65``
  573. 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.
  574. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SSCALED_PACK32:
  575. .. rst-class:: classref-enumeration-constant
  576. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_SSCALED_PACK32** = ``66``
  577. 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.
  578. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UINT_PACK32:
  579. .. rst-class:: classref-enumeration-constant
  580. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_UINT_PACK32** = ``67``
  581. 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.
  582. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SINT_PACK32:
  583. .. rst-class:: classref-enumeration-constant
  584. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_A2B10G10R10_SINT_PACK32** = ``68``
  585. 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.
  586. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UNORM:
  587. .. rst-class:: classref-enumeration-constant
  588. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_UNORM** = ``69``
  589. 16-bit-per-channel unsigned floating-point red channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  590. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SNORM:
  591. .. rst-class:: classref-enumeration-constant
  592. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SNORM** = ``70``
  593. 16-bit-per-channel signed floating-point red channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  594. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_USCALED:
  595. .. rst-class:: classref-enumeration-constant
  596. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_USCALED** = ``71``
  597. 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.
  598. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SSCALED:
  599. .. rst-class:: classref-enumeration-constant
  600. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SSCALED** = ``72``
  601. 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.
  602. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UINT:
  603. .. rst-class:: classref-enumeration-constant
  604. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_UINT** = ``73``
  605. 16-bit-per-channel unsigned integer red channel data format. Values are in the ``[0.0, 65535]`` range.
  606. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SINT:
  607. .. rst-class:: classref-enumeration-constant
  608. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SINT** = ``74``
  609. 16-bit-per-channel signed integer red channel data format. Values are in the ``[-32767, 32767]`` range.
  610. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SFLOAT:
  611. .. rst-class:: classref-enumeration-constant
  612. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16_SFLOAT** = ``75``
  613. 16-bit-per-channel signed floating-point red channel data format with the value stored as-is.
  614. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UNORM:
  615. .. rst-class:: classref-enumeration-constant
  616. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_UNORM** = ``76``
  617. 16-bit-per-channel unsigned floating-point red/green channel data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  618. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SNORM:
  619. .. rst-class:: classref-enumeration-constant
  620. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SNORM** = ``77``
  621. 16-bit-per-channel signed floating-point red/green channel data format with normalized value. Values are in the ``[-1.0, 1.0]`` range.
  622. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_USCALED:
  623. .. rst-class:: classref-enumeration-constant
  624. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_USCALED** = ``78``
  625. 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.
  626. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SSCALED:
  627. .. rst-class:: classref-enumeration-constant
  628. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SSCALED** = ``79``
  629. 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.
  630. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UINT:
  631. .. rst-class:: classref-enumeration-constant
  632. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_UINT** = ``80``
  633. 16-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0.0, 65535]`` range.
  634. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SINT:
  635. .. rst-class:: classref-enumeration-constant
  636. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SINT** = ``81``
  637. 16-bit-per-channel signed integer red/green channel data format. Values are in the ``[-32767, 32767]`` range.
  638. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SFLOAT:
  639. .. rst-class:: classref-enumeration-constant
  640. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16_SFLOAT** = ``82``
  641. 16-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
  642. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UNORM:
  643. .. rst-class:: classref-enumeration-constant
  644. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_UNORM** = ``83``
  645. 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.
  646. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SNORM:
  647. .. rst-class:: classref-enumeration-constant
  648. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SNORM** = ``84``
  649. 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.
  650. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_USCALED:
  651. .. rst-class:: classref-enumeration-constant
  652. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_USCALED** = ``85``
  653. 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.
  654. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SSCALED:
  655. .. rst-class:: classref-enumeration-constant
  656. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SSCALED** = ``86``
  657. 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.
  658. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UINT:
  659. .. rst-class:: classref-enumeration-constant
  660. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_UINT** = ``87``
  661. 16-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0.0, 65535]`` range.
  662. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SINT:
  663. .. rst-class:: classref-enumeration-constant
  664. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SINT** = ``88``
  665. 16-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[-32767, 32767]`` range.
  666. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SFLOAT:
  667. .. rst-class:: classref-enumeration-constant
  668. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16_SFLOAT** = ``89``
  669. 16-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
  670. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UNORM:
  671. .. rst-class:: classref-enumeration-constant
  672. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_UNORM** = ``90``
  673. 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.
  674. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SNORM:
  675. .. rst-class:: classref-enumeration-constant
  676. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SNORM** = ``91``
  677. 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.
  678. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_USCALED:
  679. .. rst-class:: classref-enumeration-constant
  680. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_USCALED** = ``92``
  681. 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.
  682. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SSCALED:
  683. .. rst-class:: classref-enumeration-constant
  684. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SSCALED** = ``93``
  685. 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.
  686. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UINT:
  687. .. rst-class:: classref-enumeration-constant
  688. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_UINT** = ``94``
  689. 16-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0.0, 65535]`` range.
  690. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SINT:
  691. .. rst-class:: classref-enumeration-constant
  692. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SINT** = ``95``
  693. 16-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[-32767, 32767]`` range.
  694. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SFLOAT:
  695. .. rst-class:: classref-enumeration-constant
  696. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R16G16B16A16_SFLOAT** = ``96``
  697. 16-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
  698. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_UINT:
  699. .. rst-class:: classref-enumeration-constant
  700. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32_UINT** = ``97``
  701. 32-bit-per-channel unsigned integer red channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  702. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SINT:
  703. .. rst-class:: classref-enumeration-constant
  704. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32_SINT** = ``98``
  705. 32-bit-per-channel signed integer red channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  706. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SFLOAT:
  707. .. rst-class:: classref-enumeration-constant
  708. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32_SFLOAT** = ``99``
  709. 32-bit-per-channel signed floating-point red channel data format with the value stored as-is.
  710. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_UINT:
  711. .. rst-class:: classref-enumeration-constant
  712. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32_UINT** = ``100``
  713. 32-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  714. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SINT:
  715. .. rst-class:: classref-enumeration-constant
  716. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32_SINT** = ``101``
  717. 32-bit-per-channel signed integer red/green channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  718. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SFLOAT:
  719. .. rst-class:: classref-enumeration-constant
  720. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32_SFLOAT** = ``102``
  721. 32-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
  722. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_UINT:
  723. .. rst-class:: classref-enumeration-constant
  724. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32_UINT** = ``103``
  725. 32-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  726. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SINT:
  727. .. rst-class:: classref-enumeration-constant
  728. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32_SINT** = ``104``
  729. 32-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  730. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SFLOAT:
  731. .. rst-class:: classref-enumeration-constant
  732. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32_SFLOAT** = ``105``
  733. 32-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
  734. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_UINT:
  735. .. rst-class:: classref-enumeration-constant
  736. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32A32_UINT** = ``106``
  737. 32-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0, 2^32 - 1]`` range.
  738. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SINT:
  739. .. rst-class:: classref-enumeration-constant
  740. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32A32_SINT** = ``107``
  741. 32-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[2^31 + 1, 2^31 - 1]`` range.
  742. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SFLOAT:
  743. .. rst-class:: classref-enumeration-constant
  744. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R32G32B32A32_SFLOAT** = ``108``
  745. 32-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
  746. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_UINT:
  747. .. rst-class:: classref-enumeration-constant
  748. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64_UINT** = ``109``
  749. 64-bit-per-channel unsigned integer red channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  750. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SINT:
  751. .. rst-class:: classref-enumeration-constant
  752. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64_SINT** = ``110``
  753. 64-bit-per-channel signed integer red channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  754. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SFLOAT:
  755. .. rst-class:: classref-enumeration-constant
  756. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64_SFLOAT** = ``111``
  757. 64-bit-per-channel signed floating-point red channel data format with the value stored as-is.
  758. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_UINT:
  759. .. rst-class:: classref-enumeration-constant
  760. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64_UINT** = ``112``
  761. 64-bit-per-channel unsigned integer red/green channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  762. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SINT:
  763. .. rst-class:: classref-enumeration-constant
  764. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64_SINT** = ``113``
  765. 64-bit-per-channel signed integer red/green channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  766. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SFLOAT:
  767. .. rst-class:: classref-enumeration-constant
  768. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64_SFLOAT** = ``114``
  769. 64-bit-per-channel signed floating-point red/green channel data format with the value stored as-is.
  770. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_UINT:
  771. .. rst-class:: classref-enumeration-constant
  772. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64_UINT** = ``115``
  773. 64-bit-per-channel unsigned integer red/green/blue channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  774. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SINT:
  775. .. rst-class:: classref-enumeration-constant
  776. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64_SINT** = ``116``
  777. 64-bit-per-channel signed integer red/green/blue channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  778. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SFLOAT:
  779. .. rst-class:: classref-enumeration-constant
  780. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64_SFLOAT** = ``117``
  781. 64-bit-per-channel signed floating-point red/green/blue channel data format with the value stored as-is.
  782. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_UINT:
  783. .. rst-class:: classref-enumeration-constant
  784. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64A64_UINT** = ``118``
  785. 64-bit-per-channel unsigned integer red/green/blue/alpha channel data format. Values are in the ``[0, 2^64 - 1]`` range.
  786. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SINT:
  787. .. rst-class:: classref-enumeration-constant
  788. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64A64_SINT** = ``119``
  789. 64-bit-per-channel signed integer red/green/blue/alpha channel data format. Values are in the ``[2^63 + 1, 2^63 - 1]`` range.
  790. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SFLOAT:
  791. .. rst-class:: classref-enumeration-constant
  792. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R64G64B64A64_SFLOAT** = ``120``
  793. 64-bit-per-channel signed floating-point red/green/blue/alpha channel data format with the value stored as-is.
  794. .. _class_RenderingDevice_constant_DATA_FORMAT_B10G11R11_UFLOAT_PACK32:
  795. .. rst-class:: classref-enumeration-constant
  796. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B10G11R11_UFLOAT_PACK32** = ``121``
  797. 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.
  798. .. _class_RenderingDevice_constant_DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32:
  799. .. rst-class:: classref-enumeration-constant
  800. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32** = ``122``
  801. 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.
  802. .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM:
  803. .. rst-class:: classref-enumeration-constant
  804. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D16_UNORM** = ``123``
  805. 16-bit unsigned floating-point depth data format with normalized value. Values are in the ``[0.0, 1.0]`` range.
  806. .. _class_RenderingDevice_constant_DATA_FORMAT_X8_D24_UNORM_PACK32:
  807. .. rst-class:: classref-enumeration-constant
  808. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_X8_D24_UNORM_PACK32** = ``124``
  809. 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.
  810. .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT:
  811. .. rst-class:: classref-enumeration-constant
  812. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D32_SFLOAT** = ``125``
  813. 32-bit signed floating-point depth data format with the value stored as-is.
  814. .. _class_RenderingDevice_constant_DATA_FORMAT_S8_UINT:
  815. .. rst-class:: classref-enumeration-constant
  816. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_S8_UINT** = ``126``
  817. 8-bit unsigned integer stencil data format.
  818. .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM_S8_UINT:
  819. .. rst-class:: classref-enumeration-constant
  820. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D16_UNORM_S8_UINT** = ``127``
  821. 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.
  822. .. _class_RenderingDevice_constant_DATA_FORMAT_D24_UNORM_S8_UINT:
  823. .. rst-class:: classref-enumeration-constant
  824. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D24_UNORM_S8_UINT** = ``128``
  825. 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.
  826. .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT_S8_UINT:
  827. .. rst-class:: classref-enumeration-constant
  828. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_D32_SFLOAT_S8_UINT** = ``129``
  829. 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.
  830. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_UNORM_BLOCK:
  831. .. rst-class:: classref-enumeration-constant
  832. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGB_UNORM_BLOCK** = ``130``
  833. 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).
  834. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_SRGB_BLOCK:
  835. .. rst-class:: classref-enumeration-constant
  836. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGB_SRGB_BLOCK** = ``131``
  837. 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).
  838. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_UNORM_BLOCK:
  839. .. rst-class:: classref-enumeration-constant
  840. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGBA_UNORM_BLOCK** = ``132``
  841. 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).
  842. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_SRGB_BLOCK:
  843. .. rst-class:: classref-enumeration-constant
  844. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC1_RGBA_SRGB_BLOCK** = ``133``
  845. 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).
  846. .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_UNORM_BLOCK:
  847. .. rst-class:: classref-enumeration-constant
  848. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC2_UNORM_BLOCK** = ``134``
  849. 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).
  850. .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_SRGB_BLOCK:
  851. .. rst-class:: classref-enumeration-constant
  852. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC2_SRGB_BLOCK** = ``135``
  853. 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).
  854. .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_UNORM_BLOCK:
  855. .. rst-class:: classref-enumeration-constant
  856. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC3_UNORM_BLOCK** = ``136``
  857. 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).
  858. .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_SRGB_BLOCK:
  859. .. rst-class:: classref-enumeration-constant
  860. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC3_SRGB_BLOCK** = ``137``
  861. 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).
  862. .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_UNORM_BLOCK:
  863. .. rst-class:: classref-enumeration-constant
  864. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC4_UNORM_BLOCK** = ``138``
  865. 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.
  866. .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_SNORM_BLOCK:
  867. .. rst-class:: classref-enumeration-constant
  868. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC4_SNORM_BLOCK** = ``139``
  869. 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.
  870. .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_UNORM_BLOCK:
  871. .. rst-class:: classref-enumeration-constant
  872. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC5_UNORM_BLOCK** = ``140``
  873. 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).
  874. .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_SNORM_BLOCK:
  875. .. rst-class:: classref-enumeration-constant
  876. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC5_SNORM_BLOCK** = ``141``
  877. 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).
  878. .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_UFLOAT_BLOCK:
  879. .. rst-class:: classref-enumeration-constant
  880. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC6H_UFLOAT_BLOCK** = ``142``
  881. 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).
  882. .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_SFLOAT_BLOCK:
  883. .. rst-class:: classref-enumeration-constant
  884. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC6H_SFLOAT_BLOCK** = ``143``
  885. 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).
  886. .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_UNORM_BLOCK:
  887. .. rst-class:: classref-enumeration-constant
  888. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC7_UNORM_BLOCK** = ``144``
  889. 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.
  890. .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_SRGB_BLOCK:
  891. .. rst-class:: classref-enumeration-constant
  892. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_BC7_SRGB_BLOCK** = ``145``
  893. 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.
  894. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK:
  895. .. rst-class:: classref-enumeration-constant
  896. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK** = ``146``
  897. 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.
  898. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK:
  899. .. rst-class:: classref-enumeration-constant
  900. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK** = ``147``
  901. 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.
  902. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK:
  903. .. rst-class:: classref-enumeration-constant
  904. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK** = ``148``
  905. 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.
  906. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK:
  907. .. rst-class:: classref-enumeration-constant
  908. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK** = ``149``
  909. 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.
  910. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK:
  911. .. rst-class:: classref-enumeration-constant
  912. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK** = ``150``
  913. 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.
  914. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK:
  915. .. rst-class:: classref-enumeration-constant
  916. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK** = ``151``
  917. 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.
  918. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_UNORM_BLOCK:
  919. .. rst-class:: classref-enumeration-constant
  920. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11_UNORM_BLOCK** = ``152``
  921. 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.
  922. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_SNORM_BLOCK:
  923. .. rst-class:: classref-enumeration-constant
  924. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11_SNORM_BLOCK** = ``153``
  925. 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.
  926. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_UNORM_BLOCK:
  927. .. rst-class:: classref-enumeration-constant
  928. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11G11_UNORM_BLOCK** = ``154``
  929. 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.
  930. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_SNORM_BLOCK:
  931. .. rst-class:: classref-enumeration-constant
  932. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_EAC_R11G11_SNORM_BLOCK** = ``155``
  933. 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.
  934. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_UNORM_BLOCK:
  935. .. rst-class:: classref-enumeration-constant
  936. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_4x4_UNORM_BLOCK** = ``156``
  937. 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.
  938. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_SRGB_BLOCK:
  939. .. rst-class:: classref-enumeration-constant
  940. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_4x4_SRGB_BLOCK** = ``157``
  941. 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.
  942. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_UNORM_BLOCK:
  943. .. rst-class:: classref-enumeration-constant
  944. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x4_UNORM_BLOCK** = ``158``
  945. 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.
  946. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_SRGB_BLOCK:
  947. .. rst-class:: classref-enumeration-constant
  948. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x4_SRGB_BLOCK** = ``159``
  949. 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.
  950. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_UNORM_BLOCK:
  951. .. rst-class:: classref-enumeration-constant
  952. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x5_UNORM_BLOCK** = ``160``
  953. 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.
  954. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_SRGB_BLOCK:
  955. .. rst-class:: classref-enumeration-constant
  956. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_5x5_SRGB_BLOCK** = ``161``
  957. 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.
  958. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_UNORM_BLOCK:
  959. .. rst-class:: classref-enumeration-constant
  960. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x5_UNORM_BLOCK** = ``162``
  961. 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.
  962. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_SRGB_BLOCK:
  963. .. rst-class:: classref-enumeration-constant
  964. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x5_SRGB_BLOCK** = ``163``
  965. 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.
  966. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_UNORM_BLOCK:
  967. .. rst-class:: classref-enumeration-constant
  968. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x6_UNORM_BLOCK** = ``164``
  969. 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.
  970. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_SRGB_BLOCK:
  971. .. rst-class:: classref-enumeration-constant
  972. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_6x6_SRGB_BLOCK** = ``165``
  973. 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.
  974. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_UNORM_BLOCK:
  975. .. rst-class:: classref-enumeration-constant
  976. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x5_UNORM_BLOCK** = ``166``
  977. 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.
  978. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_SRGB_BLOCK:
  979. .. rst-class:: classref-enumeration-constant
  980. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x5_SRGB_BLOCK** = ``167``
  981. 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.
  982. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_UNORM_BLOCK:
  983. .. rst-class:: classref-enumeration-constant
  984. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x6_UNORM_BLOCK** = ``168``
  985. 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.
  986. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_SRGB_BLOCK:
  987. .. rst-class:: classref-enumeration-constant
  988. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x6_SRGB_BLOCK** = ``169``
  989. 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.
  990. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_UNORM_BLOCK:
  991. .. rst-class:: classref-enumeration-constant
  992. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x8_UNORM_BLOCK** = ``170``
  993. 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.
  994. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_SRGB_BLOCK:
  995. .. rst-class:: classref-enumeration-constant
  996. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_8x8_SRGB_BLOCK** = ``171``
  997. 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.
  998. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_UNORM_BLOCK:
  999. .. rst-class:: classref-enumeration-constant
  1000. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x5_UNORM_BLOCK** = ``172``
  1001. 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.
  1002. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_SRGB_BLOCK:
  1003. .. rst-class:: classref-enumeration-constant
  1004. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x5_SRGB_BLOCK** = ``173``
  1005. 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.
  1006. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_UNORM_BLOCK:
  1007. .. rst-class:: classref-enumeration-constant
  1008. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x6_UNORM_BLOCK** = ``174``
  1009. 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.
  1010. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_SRGB_BLOCK:
  1011. .. rst-class:: classref-enumeration-constant
  1012. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x6_SRGB_BLOCK** = ``175``
  1013. 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.
  1014. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_UNORM_BLOCK:
  1015. .. rst-class:: classref-enumeration-constant
  1016. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x8_UNORM_BLOCK** = ``176``
  1017. 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.
  1018. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_SRGB_BLOCK:
  1019. .. rst-class:: classref-enumeration-constant
  1020. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x8_SRGB_BLOCK** = ``177``
  1021. 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.
  1022. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_UNORM_BLOCK:
  1023. .. rst-class:: classref-enumeration-constant
  1024. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x10_UNORM_BLOCK** = ``178``
  1025. 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.
  1026. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_SRGB_BLOCK:
  1027. .. rst-class:: classref-enumeration-constant
  1028. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_10x10_SRGB_BLOCK** = ``179``
  1029. 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.
  1030. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_UNORM_BLOCK:
  1031. .. rst-class:: classref-enumeration-constant
  1032. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x10_UNORM_BLOCK** = ``180``
  1033. 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.
  1034. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_SRGB_BLOCK:
  1035. .. rst-class:: classref-enumeration-constant
  1036. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x10_SRGB_BLOCK** = ``181``
  1037. 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.
  1038. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_UNORM_BLOCK:
  1039. .. rst-class:: classref-enumeration-constant
  1040. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x12_UNORM_BLOCK** = ``182``
  1041. 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.
  1042. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_SRGB_BLOCK:
  1043. .. rst-class:: classref-enumeration-constant
  1044. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_ASTC_12x12_SRGB_BLOCK** = ``183``
  1045. 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.
  1046. .. _class_RenderingDevice_constant_DATA_FORMAT_G8B8G8R8_422_UNORM:
  1047. .. rst-class:: classref-enumeration-constant
  1048. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8B8G8R8_422_UNORM** = ``184``
  1049. 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).
  1050. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8G8_422_UNORM:
  1051. .. rst-class:: classref-enumeration-constant
  1052. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B8G8R8G8_422_UNORM** = ``185``
  1053. 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).
  1054. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM:
  1055. .. rst-class:: classref-enumeration-constant
  1056. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM** = ``186``
  1057. 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).
  1058. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM:
  1059. .. rst-class:: classref-enumeration-constant
  1060. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM** = ``187``
  1061. 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).
  1062. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM:
  1063. .. rst-class:: classref-enumeration-constant
  1064. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM** = ``188``
  1065. 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).
  1066. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM:
  1067. .. rst-class:: classref-enumeration-constant
  1068. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM** = ``189``
  1069. 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).
  1070. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM:
  1071. .. rst-class:: classref-enumeration-constant
  1072. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM** = ``190``
  1073. 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.
  1074. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6_UNORM_PACK16:
  1075. .. rst-class:: classref-enumeration-constant
  1076. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R10X6_UNORM_PACK16** = ``191``
  1077. 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.
  1078. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6_UNORM_2PACK16:
  1079. .. rst-class:: classref-enumeration-constant
  1080. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R10X6G10X6_UNORM_2PACK16** = ``192``
  1081. 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.
  1082. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16:
  1083. .. rst-class:: classref-enumeration-constant
  1084. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16** = ``193``
  1085. 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.
  1086. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16:
  1087. .. rst-class:: classref-enumeration-constant
  1088. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16** = ``194``
  1089. 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.
  1090. .. _class_RenderingDevice_constant_DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16:
  1091. .. rst-class:: classref-enumeration-constant
  1092. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16** = ``195``
  1093. 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.
  1094. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16:
  1095. .. rst-class:: classref-enumeration-constant
  1096. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16** = ``196``
  1097. 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).
  1098. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16:
  1099. .. rst-class:: classref-enumeration-constant
  1100. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16** = ``197``
  1101. 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).
  1102. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16:
  1103. .. rst-class:: classref-enumeration-constant
  1104. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16** = ``198``
  1105. 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).
  1106. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16:
  1107. .. rst-class:: classref-enumeration-constant
  1108. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16** = ``199``
  1109. 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).
  1110. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16:
  1111. .. rst-class:: classref-enumeration-constant
  1112. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16** = ``200``
  1113. 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.
  1114. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4_UNORM_PACK16:
  1115. .. rst-class:: classref-enumeration-constant
  1116. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R12X4_UNORM_PACK16** = ``201``
  1117. 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.
  1118. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4_UNORM_2PACK16:
  1119. .. rst-class:: classref-enumeration-constant
  1120. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R12X4G12X4_UNORM_2PACK16** = ``202``
  1121. 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.
  1122. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16:
  1123. .. rst-class:: classref-enumeration-constant
  1124. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16** = ``203``
  1125. 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.
  1126. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16:
  1127. .. rst-class:: classref-enumeration-constant
  1128. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16** = ``204``
  1129. 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.
  1130. .. _class_RenderingDevice_constant_DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16:
  1131. .. rst-class:: classref-enumeration-constant
  1132. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16** = ``205``
  1133. 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.
  1134. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16:
  1135. .. rst-class:: classref-enumeration-constant
  1136. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16** = ``206``
  1137. 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).
  1138. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16:
  1139. .. rst-class:: classref-enumeration-constant
  1140. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16** = ``207``
  1141. 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).
  1142. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16:
  1143. .. rst-class:: classref-enumeration-constant
  1144. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16** = ``208``
  1145. 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).
  1146. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16:
  1147. .. rst-class:: classref-enumeration-constant
  1148. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16** = ``209``
  1149. 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).
  1150. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16:
  1151. .. rst-class:: classref-enumeration-constant
  1152. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16** = ``210``
  1153. 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.
  1154. .. _class_RenderingDevice_constant_DATA_FORMAT_G16B16G16R16_422_UNORM:
  1155. .. rst-class:: classref-enumeration-constant
  1156. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16B16G16R16_422_UNORM** = ``211``
  1157. 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).
  1158. .. _class_RenderingDevice_constant_DATA_FORMAT_B16G16R16G16_422_UNORM:
  1159. .. rst-class:: classref-enumeration-constant
  1160. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_B16G16R16G16_422_UNORM** = ``212``
  1161. 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).
  1162. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM:
  1163. .. rst-class:: classref-enumeration-constant
  1164. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM** = ``213``
  1165. 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).
  1166. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM:
  1167. .. rst-class:: classref-enumeration-constant
  1168. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM** = ``214``
  1169. 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).
  1170. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM:
  1171. .. rst-class:: classref-enumeration-constant
  1172. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM** = ``215``
  1173. 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).
  1174. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM:
  1175. .. rst-class:: classref-enumeration-constant
  1176. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM** = ``216``
  1177. 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).
  1178. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM:
  1179. .. rst-class:: classref-enumeration-constant
  1180. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM** = ``217``
  1181. 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.
  1182. .. _class_RenderingDevice_constant_DATA_FORMAT_MAX:
  1183. .. rst-class:: classref-enumeration-constant
  1184. :ref:`DataFormat<enum_RenderingDevice_DataFormat>` **DATA_FORMAT_MAX** = ``218``
  1185. Represents the size of the :ref:`DataFormat<enum_RenderingDevice_DataFormat>` enum.
  1186. .. rst-class:: classref-item-separator
  1187. ----
  1188. .. _enum_RenderingDevice_BarrierMask:
  1189. .. rst-class:: classref-enumeration
  1190. flags **BarrierMask**:
  1191. .. _class_RenderingDevice_constant_BARRIER_MASK_RASTER:
  1192. .. rst-class:: classref-enumeration-constant
  1193. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_RASTER** = ``1``
  1194. Raster barrier mask.
  1195. .. _class_RenderingDevice_constant_BARRIER_MASK_COMPUTE:
  1196. .. rst-class:: classref-enumeration-constant
  1197. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_COMPUTE** = ``2``
  1198. Compute barrier mask.
  1199. .. _class_RenderingDevice_constant_BARRIER_MASK_TRANSFER:
  1200. .. rst-class:: classref-enumeration-constant
  1201. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_TRANSFER** = ``4``
  1202. Transfer barrier mask.
  1203. .. _class_RenderingDevice_constant_BARRIER_MASK_ALL_BARRIERS:
  1204. .. rst-class:: classref-enumeration-constant
  1205. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_ALL_BARRIERS** = ``7``
  1206. Barrier mask for all types (raster, compute, transfer). Equivalent to ``BARRIER_MASK_RASTER | BARRIER_MASK_COMPUTE | BARRIER_MASK_TRANSFER``.
  1207. .. _class_RenderingDevice_constant_BARRIER_MASK_NO_BARRIER:
  1208. .. rst-class:: classref-enumeration-constant
  1209. :ref:`BarrierMask<enum_RenderingDevice_BarrierMask>` **BARRIER_MASK_NO_BARRIER** = ``8``
  1210. No barrier for any type.
  1211. .. rst-class:: classref-item-separator
  1212. ----
  1213. .. _enum_RenderingDevice_TextureType:
  1214. .. rst-class:: classref-enumeration
  1215. enum **TextureType**:
  1216. .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D:
  1217. .. rst-class:: classref-enumeration-constant
  1218. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_1D** = ``0``
  1219. 1-dimensional texture.
  1220. .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D:
  1221. .. rst-class:: classref-enumeration-constant
  1222. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_2D** = ``1``
  1223. 2-dimensional texture.
  1224. .. _class_RenderingDevice_constant_TEXTURE_TYPE_3D:
  1225. .. rst-class:: classref-enumeration-constant
  1226. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_3D** = ``2``
  1227. 3-dimensional texture.
  1228. .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE:
  1229. .. rst-class:: classref-enumeration-constant
  1230. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_CUBE** = ``3``
  1231. :ref:`Cubemap<class_Cubemap>` texture.
  1232. .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D_ARRAY:
  1233. .. rst-class:: classref-enumeration-constant
  1234. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_1D_ARRAY** = ``4``
  1235. Array of 1-dimensional textures.
  1236. .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D_ARRAY:
  1237. .. rst-class:: classref-enumeration-constant
  1238. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_2D_ARRAY** = ``5``
  1239. Array of 2-dimensional textures.
  1240. .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE_ARRAY:
  1241. .. rst-class:: classref-enumeration-constant
  1242. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_CUBE_ARRAY** = ``6``
  1243. Array of :ref:`Cubemap<class_Cubemap>` textures.
  1244. .. _class_RenderingDevice_constant_TEXTURE_TYPE_MAX:
  1245. .. rst-class:: classref-enumeration-constant
  1246. :ref:`TextureType<enum_RenderingDevice_TextureType>` **TEXTURE_TYPE_MAX** = ``7``
  1247. Represents the size of the :ref:`TextureType<enum_RenderingDevice_TextureType>` enum.
  1248. .. rst-class:: classref-item-separator
  1249. ----
  1250. .. _enum_RenderingDevice_TextureSamples:
  1251. .. rst-class:: classref-enumeration
  1252. enum **TextureSamples**:
  1253. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_1:
  1254. .. rst-class:: classref-enumeration-constant
  1255. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_1** = ``0``
  1256. Perform 1 texture sample (this is the fastest but lowest-quality for antialiasing).
  1257. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_2:
  1258. .. rst-class:: classref-enumeration-constant
  1259. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_2** = ``1``
  1260. Perform 2 texture samples.
  1261. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_4:
  1262. .. rst-class:: classref-enumeration-constant
  1263. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_4** = ``2``
  1264. Perform 4 texture samples.
  1265. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_8:
  1266. .. rst-class:: classref-enumeration-constant
  1267. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_8** = ``3``
  1268. Perform 8 texture samples. Not supported on mobile GPUs (including Apple Silicon).
  1269. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_16:
  1270. .. rst-class:: classref-enumeration-constant
  1271. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_16** = ``4``
  1272. Perform 16 texture samples. Not supported on mobile GPUs and many desktop GPUs.
  1273. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_32:
  1274. .. rst-class:: classref-enumeration-constant
  1275. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_32** = ``5``
  1276. Perform 32 texture samples. Not supported on most GPUs.
  1277. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_64:
  1278. .. rst-class:: classref-enumeration-constant
  1279. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_64** = ``6``
  1280. Perform 64 texture samples (this is the slowest but highest-quality for antialiasing). Not supported on most GPUs.
  1281. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_MAX:
  1282. .. rst-class:: classref-enumeration-constant
  1283. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **TEXTURE_SAMPLES_MAX** = ``7``
  1284. Represents the size of the :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` enum.
  1285. .. rst-class:: classref-item-separator
  1286. ----
  1287. .. _enum_RenderingDevice_TextureUsageBits:
  1288. .. rst-class:: classref-enumeration
  1289. flags **TextureUsageBits**:
  1290. .. _class_RenderingDevice_constant_TEXTURE_USAGE_SAMPLING_BIT:
  1291. .. rst-class:: classref-enumeration-constant
  1292. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_SAMPLING_BIT** = ``1``
  1293. Texture can be sampled.
  1294. .. _class_RenderingDevice_constant_TEXTURE_USAGE_COLOR_ATTACHMENT_BIT:
  1295. .. rst-class:: classref-enumeration-constant
  1296. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_COLOR_ATTACHMENT_BIT** = ``2``
  1297. Texture can be used as a color attachment in a framebuffer.
  1298. .. _class_RenderingDevice_constant_TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT:
  1299. .. rst-class:: classref-enumeration-constant
  1300. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT** = ``4``
  1301. Texture can be used as a depth/stencil attachment in a framebuffer.
  1302. .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_BIT:
  1303. .. rst-class:: classref-enumeration-constant
  1304. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_STORAGE_BIT** = ``8``
  1305. Texture can be used as a `storage image <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#descriptorsets-storageimage>`__.
  1306. .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_ATOMIC_BIT:
  1307. .. rst-class:: classref-enumeration-constant
  1308. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_STORAGE_ATOMIC_BIT** = ``16``
  1309. 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.
  1310. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CPU_READ_BIT:
  1311. .. rst-class:: classref-enumeration-constant
  1312. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CPU_READ_BIT** = ``32``
  1313. 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.
  1314. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_UPDATE_BIT:
  1315. .. rst-class:: classref-enumeration-constant
  1316. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CAN_UPDATE_BIT** = ``64``
  1317. Texture can be updated using :ref:`texture_update<class_RenderingDevice_method_texture_update>`.
  1318. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT:
  1319. .. rst-class:: classref-enumeration-constant
  1320. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CAN_COPY_FROM_BIT** = ``128``
  1321. Texture can be a source for :ref:`texture_copy<class_RenderingDevice_method_texture_copy>`.
  1322. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_TO_BIT:
  1323. .. rst-class:: classref-enumeration-constant
  1324. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_CAN_COPY_TO_BIT** = ``256``
  1325. Texture can be a destination for :ref:`texture_copy<class_RenderingDevice_method_texture_copy>`.
  1326. .. _class_RenderingDevice_constant_TEXTURE_USAGE_INPUT_ATTACHMENT_BIT:
  1327. .. rst-class:: classref-enumeration-constant
  1328. :ref:`TextureUsageBits<enum_RenderingDevice_TextureUsageBits>` **TEXTURE_USAGE_INPUT_ATTACHMENT_BIT** = ``512``
  1329. 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.
  1330. .. rst-class:: classref-item-separator
  1331. ----
  1332. .. _enum_RenderingDevice_TextureSwizzle:
  1333. .. rst-class:: classref-enumeration
  1334. enum **TextureSwizzle**:
  1335. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_IDENTITY:
  1336. .. rst-class:: classref-enumeration-constant
  1337. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_IDENTITY** = ``0``
  1338. Return the sampled value as-is.
  1339. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ZERO:
  1340. .. rst-class:: classref-enumeration-constant
  1341. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_ZERO** = ``1``
  1342. Always return ``0.0`` when sampling.
  1343. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ONE:
  1344. .. rst-class:: classref-enumeration-constant
  1345. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_ONE** = ``2``
  1346. Always return ``1.0`` when sampling.
  1347. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_R:
  1348. .. rst-class:: classref-enumeration-constant
  1349. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_R** = ``3``
  1350. Sample the red color channel.
  1351. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_G:
  1352. .. rst-class:: classref-enumeration-constant
  1353. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_G** = ``4``
  1354. Sample the green color channel.
  1355. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_B:
  1356. .. rst-class:: classref-enumeration-constant
  1357. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_B** = ``5``
  1358. Sample the blue color channel.
  1359. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_A:
  1360. .. rst-class:: classref-enumeration-constant
  1361. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_A** = ``6``
  1362. Sample the alpha channel.
  1363. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_MAX:
  1364. .. rst-class:: classref-enumeration-constant
  1365. :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` **TEXTURE_SWIZZLE_MAX** = ``7``
  1366. Represents the size of the :ref:`TextureSwizzle<enum_RenderingDevice_TextureSwizzle>` enum.
  1367. .. rst-class:: classref-item-separator
  1368. ----
  1369. .. _enum_RenderingDevice_TextureSliceType:
  1370. .. rst-class:: classref-enumeration
  1371. enum **TextureSliceType**:
  1372. .. _class_RenderingDevice_constant_TEXTURE_SLICE_2D:
  1373. .. rst-class:: classref-enumeration-constant
  1374. :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` **TEXTURE_SLICE_2D** = ``0``
  1375. 2-dimensional texture slice.
  1376. .. _class_RenderingDevice_constant_TEXTURE_SLICE_CUBEMAP:
  1377. .. rst-class:: classref-enumeration-constant
  1378. :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` **TEXTURE_SLICE_CUBEMAP** = ``1``
  1379. Cubemap texture slice.
  1380. .. _class_RenderingDevice_constant_TEXTURE_SLICE_3D:
  1381. .. rst-class:: classref-enumeration-constant
  1382. :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` **TEXTURE_SLICE_3D** = ``2``
  1383. 3-dimensional texture slice.
  1384. .. rst-class:: classref-item-separator
  1385. ----
  1386. .. _enum_RenderingDevice_SamplerFilter:
  1387. .. rst-class:: classref-enumeration
  1388. enum **SamplerFilter**:
  1389. .. _class_RenderingDevice_constant_SAMPLER_FILTER_NEAREST:
  1390. .. rst-class:: classref-enumeration-constant
  1391. :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>` **SAMPLER_FILTER_NEAREST** = ``0``
  1392. Nearest-neighbor sampler filtering. Sampling at higher resolutions than the source will result in a pixelated look.
  1393. .. _class_RenderingDevice_constant_SAMPLER_FILTER_LINEAR:
  1394. .. rst-class:: classref-enumeration-constant
  1395. :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>` **SAMPLER_FILTER_LINEAR** = ``1``
  1396. Bilinear sampler filtering. Sampling at higher resolutions than the source will result in a blurry look.
  1397. .. rst-class:: classref-item-separator
  1398. ----
  1399. .. _enum_RenderingDevice_SamplerRepeatMode:
  1400. .. rst-class:: classref-enumeration
  1401. enum **SamplerRepeatMode**:
  1402. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_REPEAT:
  1403. .. rst-class:: classref-enumeration-constant
  1404. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_REPEAT** = ``0``
  1405. Sample with repeating enabled.
  1406. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRRORED_REPEAT:
  1407. .. rst-class:: classref-enumeration-constant
  1408. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_MIRRORED_REPEAT** = ``1``
  1409. 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.
  1410. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE:
  1411. .. rst-class:: classref-enumeration-constant
  1412. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE** = ``2``
  1413. Sample with repeating disabled. When sampling outside the ``[0.0, 1.0]`` range, return the color of the last pixel on the edge.
  1414. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER:
  1415. .. rst-class:: classref-enumeration-constant
  1416. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER** = ``3``
  1417. 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>`.
  1418. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE:
  1419. .. rst-class:: classref-enumeration-constant
  1420. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE** = ``4``
  1421. 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.
  1422. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MAX:
  1423. .. rst-class:: classref-enumeration-constant
  1424. :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` **SAMPLER_REPEAT_MODE_MAX** = ``5``
  1425. Represents the size of the :ref:`SamplerRepeatMode<enum_RenderingDevice_SamplerRepeatMode>` enum.
  1426. .. rst-class:: classref-item-separator
  1427. ----
  1428. .. _enum_RenderingDevice_SamplerBorderColor:
  1429. .. rst-class:: classref-enumeration
  1430. enum **SamplerBorderColor**:
  1431. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK:
  1432. .. rst-class:: classref-enumeration-constant
  1433. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK** = ``0``
  1434. 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>`.
  1435. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK:
  1436. .. rst-class:: classref-enumeration-constant
  1437. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK** = ``1``
  1438. 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>`.
  1439. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK:
  1440. .. rst-class:: classref-enumeration-constant
  1441. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK** = ``2``
  1442. 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>`.
  1443. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK:
  1444. .. rst-class:: classref-enumeration-constant
  1445. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK** = ``3``
  1446. 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>`.
  1447. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE:
  1448. .. rst-class:: classref-enumeration-constant
  1449. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE** = ``4``
  1450. 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>`.
  1451. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE:
  1452. .. rst-class:: classref-enumeration-constant
  1453. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE** = ``5``
  1454. 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>`.
  1455. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_MAX:
  1456. .. rst-class:: classref-enumeration-constant
  1457. :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` **SAMPLER_BORDER_COLOR_MAX** = ``6``
  1458. Represents the size of the :ref:`SamplerBorderColor<enum_RenderingDevice_SamplerBorderColor>` enum.
  1459. .. rst-class:: classref-item-separator
  1460. ----
  1461. .. _enum_RenderingDevice_VertexFrequency:
  1462. .. rst-class:: classref-enumeration
  1463. enum **VertexFrequency**:
  1464. .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_VERTEX:
  1465. .. rst-class:: classref-enumeration-constant
  1466. :ref:`VertexFrequency<enum_RenderingDevice_VertexFrequency>` **VERTEX_FREQUENCY_VERTEX** = ``0``
  1467. Vertex attribute addressing is a function of the vertex. This is used to specify the rate at which vertex attributes are pulled from buffers.
  1468. .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_INSTANCE:
  1469. .. rst-class:: classref-enumeration-constant
  1470. :ref:`VertexFrequency<enum_RenderingDevice_VertexFrequency>` **VERTEX_FREQUENCY_INSTANCE** = ``1``
  1471. 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.
  1472. .. rst-class:: classref-item-separator
  1473. ----
  1474. .. _enum_RenderingDevice_IndexBufferFormat:
  1475. .. rst-class:: classref-enumeration
  1476. enum **IndexBufferFormat**:
  1477. .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT16:
  1478. .. rst-class:: classref-enumeration-constant
  1479. :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` **INDEX_BUFFER_FORMAT_UINT16** = ``0``
  1480. Index buffer in 16-bit unsigned integer format. This limits the maximum index that can be specified to ``65535``.
  1481. .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT32:
  1482. .. rst-class:: classref-enumeration-constant
  1483. :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` **INDEX_BUFFER_FORMAT_UINT32** = ``1``
  1484. Index buffer in 32-bit unsigned integer format. This limits the maximum index that can be specified to ``4294967295``.
  1485. .. rst-class:: classref-item-separator
  1486. ----
  1487. .. _enum_RenderingDevice_StorageBufferUsage:
  1488. .. rst-class:: classref-enumeration
  1489. flags **StorageBufferUsage**:
  1490. .. _class_RenderingDevice_constant_STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT:
  1491. .. rst-class:: classref-enumeration-constant
  1492. :ref:`StorageBufferUsage<enum_RenderingDevice_StorageBufferUsage>` **STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT** = ``1``
  1493. .. rst-class:: classref-item-separator
  1494. ----
  1495. .. _enum_RenderingDevice_UniformType:
  1496. .. rst-class:: classref-enumeration
  1497. enum **UniformType**:
  1498. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER:
  1499. .. rst-class:: classref-enumeration-constant
  1500. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_SAMPLER** = ``0``
  1501. Sampler uniform. TODO: Difference between sampler and texture uniform
  1502. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE:
  1503. .. rst-class:: classref-enumeration-constant
  1504. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE** = ``1``
  1505. Sampler uniform with a texture.
  1506. .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE:
  1507. .. rst-class:: classref-enumeration-constant
  1508. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_TEXTURE** = ``2``
  1509. Texture uniform.
  1510. .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE:
  1511. .. rst-class:: classref-enumeration-constant
  1512. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_IMAGE** = ``3``
  1513. Image uniform. TODO: Difference between texture and image uniform
  1514. .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE_BUFFER:
  1515. .. rst-class:: classref-enumeration-constant
  1516. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_TEXTURE_BUFFER** = ``4``
  1517. Texture buffer uniform. TODO: Difference between texture and texture buffe uniformr
  1518. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER:
  1519. .. rst-class:: classref-enumeration-constant
  1520. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER** = ``5``
  1521. Sampler uniform with a texture buffer. TODO: Difference between texture and texture buffer uniform
  1522. .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE_BUFFER:
  1523. .. rst-class:: classref-enumeration-constant
  1524. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_IMAGE_BUFFER** = ``6``
  1525. Image buffer uniform. TODO: Difference between texture and image uniforms
  1526. .. _class_RenderingDevice_constant_UNIFORM_TYPE_UNIFORM_BUFFER:
  1527. .. rst-class:: classref-enumeration-constant
  1528. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_UNIFORM_BUFFER** = ``7``
  1529. Uniform buffer uniform.
  1530. .. _class_RenderingDevice_constant_UNIFORM_TYPE_STORAGE_BUFFER:
  1531. .. rst-class:: classref-enumeration-constant
  1532. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_STORAGE_BUFFER** = ``8``
  1533. `Storage buffer <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ uniform.
  1534. .. _class_RenderingDevice_constant_UNIFORM_TYPE_INPUT_ATTACHMENT:
  1535. .. rst-class:: classref-enumeration-constant
  1536. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_INPUT_ATTACHMENT** = ``9``
  1537. Input attachment uniform.
  1538. .. _class_RenderingDevice_constant_UNIFORM_TYPE_MAX:
  1539. .. rst-class:: classref-enumeration-constant
  1540. :ref:`UniformType<enum_RenderingDevice_UniformType>` **UNIFORM_TYPE_MAX** = ``10``
  1541. Represents the size of the :ref:`UniformType<enum_RenderingDevice_UniformType>` enum.
  1542. .. rst-class:: classref-item-separator
  1543. ----
  1544. .. _enum_RenderingDevice_RenderPrimitive:
  1545. .. rst-class:: classref-enumeration
  1546. enum **RenderPrimitive**:
  1547. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_POINTS:
  1548. .. rst-class:: classref-enumeration-constant
  1549. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_POINTS** = ``0``
  1550. Point rendering primitive (with constant size, regardless of distance from camera).
  1551. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES:
  1552. .. rst-class:: classref-enumeration-constant
  1553. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINES** = ``1``
  1554. Line list rendering primitive. Lines are drawn separated from each other.
  1555. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES_WITH_ADJACENCY:
  1556. .. rst-class:: classref-enumeration-constant
  1557. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINES_WITH_ADJACENCY** = ``2``
  1558. `Line list rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-line-lists-with-adjacency>`__\
  1559. \ **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1560. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS:
  1561. .. rst-class:: classref-enumeration-constant
  1562. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINESTRIPS** = ``3``
  1563. Line strip rendering primitive. Lines drawn are connected to the previous vertex.
  1564. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY:
  1565. .. rst-class:: classref-enumeration-constant
  1566. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY** = ``4``
  1567. `Line strip rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-line-strips-with-adjacency>`__\
  1568. \ **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1569. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES:
  1570. .. rst-class:: classref-enumeration-constant
  1571. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLES** = ``5``
  1572. Triangle list rendering primitive. Triangles are drawn separated from each other.
  1573. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY:
  1574. .. rst-class:: classref-enumeration-constant
  1575. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY** = ``6``
  1576. `Triangle list rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-triangle-lists-with-adjacency>`__\
  1577. **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1578. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS:
  1579. .. rst-class:: classref-enumeration-constant
  1580. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLE_STRIPS** = ``7``
  1581. Triangle strip rendering primitive. Triangles drawn are connected to the previous triangle.
  1582. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY:
  1583. .. rst-class:: classref-enumeration-constant
  1584. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY** = ``8``
  1585. `Triangle strip rendering primitive with adjacency. <https://registry.khronos.org/vulkan/specs/1.3-extensions/html/vkspec.html#drawing-triangle-strips-with-adjacency>`__\
  1586. \ **Note:** Adjacency is only useful with geometry shaders, which Godot does not expose.
  1587. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX:
  1588. .. rst-class:: classref-enumeration-constant
  1589. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX** = ``9``
  1590. 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.
  1591. \ **Note:** Only compatible with indexed draws.
  1592. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TESSELATION_PATCH:
  1593. .. rst-class:: classref-enumeration-constant
  1594. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_TESSELATION_PATCH** = ``10``
  1595. Tessellation patch rendering primitive. Only useful with tessellation shaders, which can be used to deform these patches.
  1596. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_MAX:
  1597. .. rst-class:: classref-enumeration-constant
  1598. :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` **RENDER_PRIMITIVE_MAX** = ``11``
  1599. Represents the size of the :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` enum.
  1600. .. rst-class:: classref-item-separator
  1601. ----
  1602. .. _enum_RenderingDevice_PolygonCullMode:
  1603. .. rst-class:: classref-enumeration
  1604. enum **PolygonCullMode**:
  1605. .. _class_RenderingDevice_constant_POLYGON_CULL_DISABLED:
  1606. .. rst-class:: classref-enumeration-constant
  1607. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **POLYGON_CULL_DISABLED** = ``0``
  1608. Do not use polygon front face or backface culling.
  1609. .. _class_RenderingDevice_constant_POLYGON_CULL_FRONT:
  1610. .. rst-class:: classref-enumeration-constant
  1611. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **POLYGON_CULL_FRONT** = ``1``
  1612. Use polygon frontface culling (faces pointing towards the camera are hidden).
  1613. .. _class_RenderingDevice_constant_POLYGON_CULL_BACK:
  1614. .. rst-class:: classref-enumeration-constant
  1615. :ref:`PolygonCullMode<enum_RenderingDevice_PolygonCullMode>` **POLYGON_CULL_BACK** = ``2``
  1616. Use polygon backface culling (faces pointing away from the camera are hidden).
  1617. .. rst-class:: classref-item-separator
  1618. ----
  1619. .. _enum_RenderingDevice_PolygonFrontFace:
  1620. .. rst-class:: classref-enumeration
  1621. enum **PolygonFrontFace**:
  1622. .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_CLOCKWISE:
  1623. .. rst-class:: classref-enumeration-constant
  1624. :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` **POLYGON_FRONT_FACE_CLOCKWISE** = ``0``
  1625. Clockwise winding order to determine which face of a polygon is its front face.
  1626. .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_COUNTER_CLOCKWISE:
  1627. .. rst-class:: classref-enumeration-constant
  1628. :ref:`PolygonFrontFace<enum_RenderingDevice_PolygonFrontFace>` **POLYGON_FRONT_FACE_COUNTER_CLOCKWISE** = ``1``
  1629. Counter-clockwise winding order to determine which face of a polygon is its front face.
  1630. .. rst-class:: classref-item-separator
  1631. ----
  1632. .. _enum_RenderingDevice_StencilOperation:
  1633. .. rst-class:: classref-enumeration
  1634. enum **StencilOperation**:
  1635. .. _class_RenderingDevice_constant_STENCIL_OP_KEEP:
  1636. .. rst-class:: classref-enumeration-constant
  1637. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_KEEP** = ``0``
  1638. Keep the current stencil value.
  1639. .. _class_RenderingDevice_constant_STENCIL_OP_ZERO:
  1640. .. rst-class:: classref-enumeration-constant
  1641. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_ZERO** = ``1``
  1642. Set the stencil value to ``0``.
  1643. .. _class_RenderingDevice_constant_STENCIL_OP_REPLACE:
  1644. .. rst-class:: classref-enumeration-constant
  1645. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_REPLACE** = ``2``
  1646. Replace the existing stencil value with the new one.
  1647. .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_CLAMP:
  1648. .. rst-class:: classref-enumeration-constant
  1649. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_INCREMENT_AND_CLAMP** = ``3``
  1650. Increment the existing stencil value and clamp to the maximum representable unsigned value if reached. Stencil bits are considered as an unsigned integer.
  1651. .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_CLAMP:
  1652. .. rst-class:: classref-enumeration-constant
  1653. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_DECREMENT_AND_CLAMP** = ``4``
  1654. Decrement the existing stencil value and clamp to the minimum value if reached. Stencil bits are considered as an unsigned integer.
  1655. .. _class_RenderingDevice_constant_STENCIL_OP_INVERT:
  1656. .. rst-class:: classref-enumeration-constant
  1657. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_INVERT** = ``5``
  1658. Bitwise-invert the existing stencil value.
  1659. .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_WRAP:
  1660. .. rst-class:: classref-enumeration-constant
  1661. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_INCREMENT_AND_WRAP** = ``6``
  1662. Increment the stencil value and wrap around to ``0`` if reaching the maximum representable unsigned. Stencil bits are considered as an unsigned integer.
  1663. .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_WRAP:
  1664. .. rst-class:: classref-enumeration-constant
  1665. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_DECREMENT_AND_WRAP** = ``7``
  1666. Decrement the stencil value and wrap around to the maximum representable unsigned if reaching the minimum. Stencil bits are considered as an unsigned integer.
  1667. .. _class_RenderingDevice_constant_STENCIL_OP_MAX:
  1668. .. rst-class:: classref-enumeration-constant
  1669. :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` **STENCIL_OP_MAX** = ``8``
  1670. Represents the size of the :ref:`StencilOperation<enum_RenderingDevice_StencilOperation>` enum.
  1671. .. rst-class:: classref-item-separator
  1672. ----
  1673. .. _enum_RenderingDevice_CompareOperator:
  1674. .. rst-class:: classref-enumeration
  1675. enum **CompareOperator**:
  1676. .. _class_RenderingDevice_constant_COMPARE_OP_NEVER:
  1677. .. rst-class:: classref-enumeration-constant
  1678. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_NEVER** = ``0``
  1679. "Never" comparison (opposite of :ref:`COMPARE_OP_ALWAYS<class_RenderingDevice_constant_COMPARE_OP_ALWAYS>`).
  1680. .. _class_RenderingDevice_constant_COMPARE_OP_LESS:
  1681. .. rst-class:: classref-enumeration-constant
  1682. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_LESS** = ``1``
  1683. "Less than" comparison.
  1684. .. _class_RenderingDevice_constant_COMPARE_OP_EQUAL:
  1685. .. rst-class:: classref-enumeration-constant
  1686. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_EQUAL** = ``2``
  1687. "Equal" comparison.
  1688. .. _class_RenderingDevice_constant_COMPARE_OP_LESS_OR_EQUAL:
  1689. .. rst-class:: classref-enumeration-constant
  1690. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_LESS_OR_EQUAL** = ``3``
  1691. "Less than or equal" comparison.
  1692. .. _class_RenderingDevice_constant_COMPARE_OP_GREATER:
  1693. .. rst-class:: classref-enumeration-constant
  1694. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_GREATER** = ``4``
  1695. "Greater than" comparison.
  1696. .. _class_RenderingDevice_constant_COMPARE_OP_NOT_EQUAL:
  1697. .. rst-class:: classref-enumeration-constant
  1698. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_NOT_EQUAL** = ``5``
  1699. "Not equal" comparison.
  1700. .. _class_RenderingDevice_constant_COMPARE_OP_GREATER_OR_EQUAL:
  1701. .. rst-class:: classref-enumeration-constant
  1702. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_GREATER_OR_EQUAL** = ``6``
  1703. "Greater than or equal" comparison.
  1704. .. _class_RenderingDevice_constant_COMPARE_OP_ALWAYS:
  1705. .. rst-class:: classref-enumeration-constant
  1706. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_ALWAYS** = ``7``
  1707. "Always" comparison (opposite of :ref:`COMPARE_OP_NEVER<class_RenderingDevice_constant_COMPARE_OP_NEVER>`).
  1708. .. _class_RenderingDevice_constant_COMPARE_OP_MAX:
  1709. .. rst-class:: classref-enumeration-constant
  1710. :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` **COMPARE_OP_MAX** = ``8``
  1711. Represents the size of the :ref:`CompareOperator<enum_RenderingDevice_CompareOperator>` enum.
  1712. .. rst-class:: classref-item-separator
  1713. ----
  1714. .. _enum_RenderingDevice_LogicOperation:
  1715. .. rst-class:: classref-enumeration
  1716. enum **LogicOperation**:
  1717. .. _class_RenderingDevice_constant_LOGIC_OP_CLEAR:
  1718. .. rst-class:: classref-enumeration-constant
  1719. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_CLEAR** = ``0``
  1720. Clear logic operation (result is always ``0``). See also :ref:`LOGIC_OP_SET<class_RenderingDevice_constant_LOGIC_OP_SET>`.
  1721. .. _class_RenderingDevice_constant_LOGIC_OP_AND:
  1722. .. rst-class:: classref-enumeration-constant
  1723. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_AND** = ``1``
  1724. AND logic operation.
  1725. .. _class_RenderingDevice_constant_LOGIC_OP_AND_REVERSE:
  1726. .. rst-class:: classref-enumeration-constant
  1727. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_AND_REVERSE** = ``2``
  1728. AND logic operation with the *destination* operand being inverted. See also :ref:`LOGIC_OP_AND_INVERTED<class_RenderingDevice_constant_LOGIC_OP_AND_INVERTED>`.
  1729. .. _class_RenderingDevice_constant_LOGIC_OP_COPY:
  1730. .. rst-class:: classref-enumeration-constant
  1731. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_COPY** = ``3``
  1732. 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>`.
  1733. .. _class_RenderingDevice_constant_LOGIC_OP_AND_INVERTED:
  1734. .. rst-class:: classref-enumeration-constant
  1735. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_AND_INVERTED** = ``4``
  1736. AND logic operation with the *source* operand being inverted. See also :ref:`LOGIC_OP_AND_REVERSE<class_RenderingDevice_constant_LOGIC_OP_AND_REVERSE>`.
  1737. .. _class_RenderingDevice_constant_LOGIC_OP_NO_OP:
  1738. .. rst-class:: classref-enumeration-constant
  1739. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_NO_OP** = ``5``
  1740. No-op logic operation (keeps the *destination* value as-is). See also :ref:`LOGIC_OP_COPY<class_RenderingDevice_constant_LOGIC_OP_COPY>`.
  1741. .. _class_RenderingDevice_constant_LOGIC_OP_XOR:
  1742. .. rst-class:: classref-enumeration-constant
  1743. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_XOR** = ``6``
  1744. Exclusive or (XOR) logic operation.
  1745. .. _class_RenderingDevice_constant_LOGIC_OP_OR:
  1746. .. rst-class:: classref-enumeration-constant
  1747. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_OR** = ``7``
  1748. OR logic operation.
  1749. .. _class_RenderingDevice_constant_LOGIC_OP_NOR:
  1750. .. rst-class:: classref-enumeration-constant
  1751. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_NOR** = ``8``
  1752. Not-OR (NOR) logic operation.
  1753. .. _class_RenderingDevice_constant_LOGIC_OP_EQUIVALENT:
  1754. .. rst-class:: classref-enumeration-constant
  1755. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_EQUIVALENT** = ``9``
  1756. Not-XOR (XNOR) logic operation.
  1757. .. _class_RenderingDevice_constant_LOGIC_OP_INVERT:
  1758. .. rst-class:: classref-enumeration-constant
  1759. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_INVERT** = ``10``
  1760. Invert logic operation.
  1761. .. _class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE:
  1762. .. rst-class:: classref-enumeration-constant
  1763. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_OR_REVERSE** = ``11``
  1764. OR logic operation with the *destination* operand being inverted. See also :ref:`LOGIC_OP_OR_REVERSE<class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE>`.
  1765. .. _class_RenderingDevice_constant_LOGIC_OP_COPY_INVERTED:
  1766. .. rst-class:: classref-enumeration-constant
  1767. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_COPY_INVERTED** = ``12``
  1768. NOT logic operation (inverts the value). See also :ref:`LOGIC_OP_COPY<class_RenderingDevice_constant_LOGIC_OP_COPY>`.
  1769. .. _class_RenderingDevice_constant_LOGIC_OP_OR_INVERTED:
  1770. .. rst-class:: classref-enumeration-constant
  1771. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_OR_INVERTED** = ``13``
  1772. OR logic operation with the *source* operand being inverted. See also :ref:`LOGIC_OP_OR_REVERSE<class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE>`.
  1773. .. _class_RenderingDevice_constant_LOGIC_OP_NAND:
  1774. .. rst-class:: classref-enumeration-constant
  1775. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_NAND** = ``14``
  1776. Not-AND (NAND) logic operation.
  1777. .. _class_RenderingDevice_constant_LOGIC_OP_SET:
  1778. .. rst-class:: classref-enumeration-constant
  1779. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_SET** = ``15``
  1780. SET logic operation (result is always ``1``). See also :ref:`LOGIC_OP_CLEAR<class_RenderingDevice_constant_LOGIC_OP_CLEAR>`.
  1781. .. _class_RenderingDevice_constant_LOGIC_OP_MAX:
  1782. .. rst-class:: classref-enumeration-constant
  1783. :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` **LOGIC_OP_MAX** = ``16``
  1784. Represents the size of the :ref:`LogicOperation<enum_RenderingDevice_LogicOperation>` enum.
  1785. .. rst-class:: classref-item-separator
  1786. ----
  1787. .. _enum_RenderingDevice_BlendFactor:
  1788. .. rst-class:: classref-enumeration
  1789. enum **BlendFactor**:
  1790. .. _class_RenderingDevice_constant_BLEND_FACTOR_ZERO:
  1791. .. rst-class:: classref-enumeration-constant
  1792. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ZERO** = ``0``
  1793. Constant ``0.0`` blend factor.
  1794. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE:
  1795. .. rst-class:: classref-enumeration-constant
  1796. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE** = ``1``
  1797. Constant ``1.0`` blend factor.
  1798. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_COLOR:
  1799. .. rst-class:: classref-enumeration-constant
  1800. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC_COLOR** = ``2``
  1801. Color blend factor is ``source color``. Alpha blend factor is ``source alpha``.
  1802. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_COLOR:
  1803. .. rst-class:: classref-enumeration-constant
  1804. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC_COLOR** = ``3``
  1805. Color blend factor is ``1.0 - source color``. Alpha blend factor is ``1.0 - source alpha``.
  1806. .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_COLOR:
  1807. .. rst-class:: classref-enumeration-constant
  1808. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_DST_COLOR** = ``4``
  1809. Color blend factor is ``destination color``. Alpha blend factor is ``destination alpha``.
  1810. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_COLOR:
  1811. .. rst-class:: classref-enumeration-constant
  1812. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_DST_COLOR** = ``5``
  1813. Color blend factor is ``1.0 - destination color``. Alpha blend factor is ``1.0 - destination alpha``.
  1814. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA:
  1815. .. rst-class:: classref-enumeration-constant
  1816. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC_ALPHA** = ``6``
  1817. Color and alpha blend factor is ``source alpha``.
  1818. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA:
  1819. .. rst-class:: classref-enumeration-constant
  1820. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC_ALPHA** = ``7``
  1821. Color and alpha blend factor is ``1.0 - source alpha``.
  1822. .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_ALPHA:
  1823. .. rst-class:: classref-enumeration-constant
  1824. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_DST_ALPHA** = ``8``
  1825. Color and alpha blend factor is ``destination alpha``.
  1826. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_ALPHA:
  1827. .. rst-class:: classref-enumeration-constant
  1828. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_DST_ALPHA** = ``9``
  1829. Color and alpha blend factor is ``1.0 - destination alpha``.
  1830. .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_COLOR:
  1831. .. rst-class:: classref-enumeration-constant
  1832. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_CONSTANT_COLOR** = ``10``
  1833. 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>`).
  1834. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR:
  1835. .. rst-class:: classref-enumeration-constant
  1836. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR** = ``11``
  1837. 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>`).
  1838. .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_ALPHA:
  1839. .. rst-class:: classref-enumeration-constant
  1840. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_CONSTANT_ALPHA** = ``12``
  1841. Color and alpha blend factor is ``blend constant alpha`` (see :ref:`draw_list_set_blend_constants<class_RenderingDevice_method_draw_list_set_blend_constants>`).
  1842. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA:
  1843. .. rst-class:: classref-enumeration-constant
  1844. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA** = ``13``
  1845. 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>`).
  1846. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA_SATURATE:
  1847. .. rst-class:: classref-enumeration-constant
  1848. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC_ALPHA_SATURATE** = ``14``
  1849. Color blend factor is ``min(source alpha, 1.0 - destination alpha)``. Alpha blend factor is ``1.0``.
  1850. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_COLOR:
  1851. .. rst-class:: classref-enumeration-constant
  1852. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC1_COLOR** = ``15``
  1853. Color blend factor is ``second source color``. Alpha blend factor is ``second source alpha``. Only relevant for dual-source blending.
  1854. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR:
  1855. .. rst-class:: classref-enumeration-constant
  1856. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC1_COLOR** = ``16``
  1857. Color blend factor is ``1.0 - second source color``. Alpha blend factor is ``1.0 - second source alpha``. Only relevant for dual-source blending.
  1858. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_ALPHA:
  1859. .. rst-class:: classref-enumeration-constant
  1860. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_SRC1_ALPHA** = ``17``
  1861. Color and alpha blend factor is ``second source alpha``. Only relevant for dual-source blending.
  1862. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA:
  1863. .. rst-class:: classref-enumeration-constant
  1864. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA** = ``18``
  1865. Color and alpha blend factor is ``1.0 - second source alpha``. Only relevant for dual-source blending.
  1866. .. _class_RenderingDevice_constant_BLEND_FACTOR_MAX:
  1867. .. rst-class:: classref-enumeration-constant
  1868. :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` **BLEND_FACTOR_MAX** = ``19``
  1869. Represents the size of the :ref:`BlendFactor<enum_RenderingDevice_BlendFactor>` enum.
  1870. .. rst-class:: classref-item-separator
  1871. ----
  1872. .. _enum_RenderingDevice_BlendOperation:
  1873. .. rst-class:: classref-enumeration
  1874. enum **BlendOperation**:
  1875. .. _class_RenderingDevice_constant_BLEND_OP_ADD:
  1876. .. rst-class:: classref-enumeration-constant
  1877. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_ADD** = ``0``
  1878. Additive blending operation (``source + destination``).
  1879. .. _class_RenderingDevice_constant_BLEND_OP_SUBTRACT:
  1880. .. rst-class:: classref-enumeration-constant
  1881. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_SUBTRACT** = ``1``
  1882. Subtractive blending operation (``source - destination``).
  1883. .. _class_RenderingDevice_constant_BLEND_OP_REVERSE_SUBTRACT:
  1884. .. rst-class:: classref-enumeration-constant
  1885. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_REVERSE_SUBTRACT** = ``2``
  1886. Reverse subtractive blending operation (``destination - source``).
  1887. .. _class_RenderingDevice_constant_BLEND_OP_MINIMUM:
  1888. .. rst-class:: classref-enumeration-constant
  1889. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_MINIMUM** = ``3``
  1890. Minimum blending operation (keep the lowest value of the two).
  1891. .. _class_RenderingDevice_constant_BLEND_OP_MAXIMUM:
  1892. .. rst-class:: classref-enumeration-constant
  1893. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_MAXIMUM** = ``4``
  1894. Maximum blending operation (keep the highest value of the two).
  1895. .. _class_RenderingDevice_constant_BLEND_OP_MAX:
  1896. .. rst-class:: classref-enumeration-constant
  1897. :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` **BLEND_OP_MAX** = ``5``
  1898. Represents the size of the :ref:`BlendOperation<enum_RenderingDevice_BlendOperation>` enum.
  1899. .. rst-class:: classref-item-separator
  1900. ----
  1901. .. _enum_RenderingDevice_PipelineDynamicStateFlags:
  1902. .. rst-class:: classref-enumeration
  1903. flags **PipelineDynamicStateFlags**:
  1904. .. _class_RenderingDevice_constant_DYNAMIC_STATE_LINE_WIDTH:
  1905. .. rst-class:: classref-enumeration-constant
  1906. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_LINE_WIDTH** = ``1``
  1907. .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BIAS:
  1908. .. rst-class:: classref-enumeration-constant
  1909. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_DEPTH_BIAS** = ``2``
  1910. .. _class_RenderingDevice_constant_DYNAMIC_STATE_BLEND_CONSTANTS:
  1911. .. rst-class:: classref-enumeration-constant
  1912. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_BLEND_CONSTANTS** = ``4``
  1913. .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BOUNDS:
  1914. .. rst-class:: classref-enumeration-constant
  1915. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_DEPTH_BOUNDS** = ``8``
  1916. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_COMPARE_MASK:
  1917. .. rst-class:: classref-enumeration-constant
  1918. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_STENCIL_COMPARE_MASK** = ``16``
  1919. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_WRITE_MASK:
  1920. .. rst-class:: classref-enumeration-constant
  1921. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_STENCIL_WRITE_MASK** = ``32``
  1922. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_REFERENCE:
  1923. .. rst-class:: classref-enumeration-constant
  1924. :ref:`PipelineDynamicStateFlags<enum_RenderingDevice_PipelineDynamicStateFlags>` **DYNAMIC_STATE_STENCIL_REFERENCE** = ``64``
  1925. .. rst-class:: classref-item-separator
  1926. ----
  1927. .. _enum_RenderingDevice_InitialAction:
  1928. .. rst-class:: classref-enumeration
  1929. enum **InitialAction**:
  1930. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR:
  1931. .. rst-class:: classref-enumeration-constant
  1932. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CLEAR** = ``0``
  1933. Start rendering and clear the whole framebuffer.
  1934. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION:
  1935. .. rst-class:: classref-enumeration-constant
  1936. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CLEAR_REGION** = ``1``
  1937. Start rendering and clear the framebuffer in the specified region.
  1938. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION_CONTINUE:
  1939. .. rst-class:: classref-enumeration-constant
  1940. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CLEAR_REGION_CONTINUE** = ``2``
  1941. 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.
  1942. .. _class_RenderingDevice_constant_INITIAL_ACTION_KEEP:
  1943. .. rst-class:: classref-enumeration-constant
  1944. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_KEEP** = ``3``
  1945. 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.
  1946. .. _class_RenderingDevice_constant_INITIAL_ACTION_DROP:
  1947. .. rst-class:: classref-enumeration-constant
  1948. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_DROP** = ``4``
  1949. 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.
  1950. .. _class_RenderingDevice_constant_INITIAL_ACTION_CONTINUE:
  1951. .. rst-class:: classref-enumeration-constant
  1952. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_CONTINUE** = ``5``
  1953. Continue rendering. Framebuffer must have been left in :ref:`FINAL_ACTION_CONTINUE<class_RenderingDevice_constant_FINAL_ACTION_CONTINUE>` state as the final action previously.
  1954. .. _class_RenderingDevice_constant_INITIAL_ACTION_MAX:
  1955. .. rst-class:: classref-enumeration-constant
  1956. :ref:`InitialAction<enum_RenderingDevice_InitialAction>` **INITIAL_ACTION_MAX** = ``6``
  1957. Represents the size of the :ref:`InitialAction<enum_RenderingDevice_InitialAction>` enum.
  1958. .. rst-class:: classref-item-separator
  1959. ----
  1960. .. _enum_RenderingDevice_FinalAction:
  1961. .. rst-class:: classref-enumeration
  1962. enum **FinalAction**:
  1963. .. _class_RenderingDevice_constant_FINAL_ACTION_READ:
  1964. .. rst-class:: classref-enumeration-constant
  1965. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_READ** = ``0``
  1966. 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).
  1967. .. _class_RenderingDevice_constant_FINAL_ACTION_DISCARD:
  1968. .. rst-class:: classref-enumeration-constant
  1969. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_DISCARD** = ``1``
  1970. 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).
  1971. .. _class_RenderingDevice_constant_FINAL_ACTION_CONTINUE:
  1972. .. rst-class:: classref-enumeration-constant
  1973. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_CONTINUE** = ``2``
  1974. 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.
  1975. .. _class_RenderingDevice_constant_FINAL_ACTION_MAX:
  1976. .. rst-class:: classref-enumeration-constant
  1977. :ref:`FinalAction<enum_RenderingDevice_FinalAction>` **FINAL_ACTION_MAX** = ``3``
  1978. Represents the size of the :ref:`FinalAction<enum_RenderingDevice_FinalAction>` enum.
  1979. .. rst-class:: classref-item-separator
  1980. ----
  1981. .. _enum_RenderingDevice_ShaderStage:
  1982. .. rst-class:: classref-enumeration
  1983. enum **ShaderStage**:
  1984. .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX:
  1985. .. rst-class:: classref-enumeration-constant
  1986. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_VERTEX** = ``0``
  1987. Vertex shader stage. This can be used to manipulate vertices from a shader (but not create new vertices).
  1988. .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT:
  1989. .. rst-class:: classref-enumeration-constant
  1990. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_FRAGMENT** = ``1``
  1991. Fragment shader stage (called "pixel shader" in Direct3D). This can be used to manipulate pixels from a shader.
  1992. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL:
  1993. .. rst-class:: classref-enumeration-constant
  1994. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_CONTROL** = ``2``
  1995. Tessellation control shader stage. This can be used to create additional geometry from a shader.
  1996. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION:
  1997. .. rst-class:: classref-enumeration-constant
  1998. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_EVALUATION** = ``3``
  1999. Tessellation evaluation shader stage. This can be used to create additional geometry from a shader.
  2000. .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE:
  2001. .. rst-class:: classref-enumeration-constant
  2002. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_COMPUTE** = ``4``
  2003. Compute shader stage. This can be used to run arbitrary computing tasks in a shader, performing them on the GPU instead of the CPU.
  2004. .. _class_RenderingDevice_constant_SHADER_STAGE_MAX:
  2005. .. rst-class:: classref-enumeration-constant
  2006. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_MAX** = ``5``
  2007. Represents the size of the :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` enum.
  2008. .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX_BIT:
  2009. .. rst-class:: classref-enumeration-constant
  2010. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_VERTEX_BIT** = ``1``
  2011. Vertex shader stage bit (see also :ref:`SHADER_STAGE_VERTEX<class_RenderingDevice_constant_SHADER_STAGE_VERTEX>`).
  2012. .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT_BIT:
  2013. .. rst-class:: classref-enumeration-constant
  2014. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_FRAGMENT_BIT** = ``2``
  2015. Fragment shader stage bit (see also :ref:`SHADER_STAGE_FRAGMENT<class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT>`).
  2016. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL_BIT:
  2017. .. rst-class:: classref-enumeration-constant
  2018. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_CONTROL_BIT** = ``4``
  2019. Tessellation control shader stage bit (see also :ref:`SHADER_STAGE_TESSELATION_CONTROL<class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL>`).
  2020. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION_BIT:
  2021. .. rst-class:: classref-enumeration-constant
  2022. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_TESSELATION_EVALUATION_BIT** = ``8``
  2023. Tessellation evaluation shader stage bit (see also :ref:`SHADER_STAGE_TESSELATION_EVALUATION<class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION>`).
  2024. .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE_BIT:
  2025. .. rst-class:: classref-enumeration-constant
  2026. :ref:`ShaderStage<enum_RenderingDevice_ShaderStage>` **SHADER_STAGE_COMPUTE_BIT** = ``16``
  2027. Compute shader stage bit (see also :ref:`SHADER_STAGE_COMPUTE<class_RenderingDevice_constant_SHADER_STAGE_COMPUTE>`).
  2028. .. rst-class:: classref-item-separator
  2029. ----
  2030. .. _enum_RenderingDevice_ShaderLanguage:
  2031. .. rst-class:: classref-enumeration
  2032. enum **ShaderLanguage**:
  2033. .. _class_RenderingDevice_constant_SHADER_LANGUAGE_GLSL:
  2034. .. rst-class:: classref-enumeration-constant
  2035. :ref:`ShaderLanguage<enum_RenderingDevice_ShaderLanguage>` **SHADER_LANGUAGE_GLSL** = ``0``
  2036. Khronos' GLSL shading language (used natively by OpenGL and Vulkan). This is the language used for core Godot shaders.
  2037. .. _class_RenderingDevice_constant_SHADER_LANGUAGE_HLSL:
  2038. .. rst-class:: classref-enumeration-constant
  2039. :ref:`ShaderLanguage<enum_RenderingDevice_ShaderLanguage>` **SHADER_LANGUAGE_HLSL** = ``1``
  2040. Microsoft's High-Level Shading Language (used natively by Direct3D, but can also be used in Vulkan).
  2041. .. rst-class:: classref-item-separator
  2042. ----
  2043. .. _enum_RenderingDevice_PipelineSpecializationConstantType:
  2044. .. rst-class:: classref-enumeration
  2045. enum **PipelineSpecializationConstantType**:
  2046. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL:
  2047. .. rst-class:: classref-enumeration-constant
  2048. :ref:`PipelineSpecializationConstantType<enum_RenderingDevice_PipelineSpecializationConstantType>` **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL** = ``0``
  2049. Boolean specialization constant.
  2050. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT:
  2051. .. rst-class:: classref-enumeration-constant
  2052. :ref:`PipelineSpecializationConstantType<enum_RenderingDevice_PipelineSpecializationConstantType>` **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT** = ``1``
  2053. Integer specialization constant.
  2054. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT:
  2055. .. rst-class:: classref-enumeration-constant
  2056. :ref:`PipelineSpecializationConstantType<enum_RenderingDevice_PipelineSpecializationConstantType>` **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT** = ``2``
  2057. Floating-point specialization constant.
  2058. .. rst-class:: classref-item-separator
  2059. ----
  2060. .. _enum_RenderingDevice_Limit:
  2061. .. rst-class:: classref-enumeration
  2062. enum **Limit**:
  2063. .. _class_RenderingDevice_constant_LIMIT_MAX_BOUND_UNIFORM_SETS:
  2064. .. rst-class:: classref-enumeration-constant
  2065. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_BOUND_UNIFORM_SETS** = ``0``
  2066. Maximum number of uniform sets that can be bound at a given time.
  2067. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS:
  2068. .. rst-class:: classref-enumeration-constant
  2069. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS** = ``1``
  2070. Maximum number of color framebuffer attachments that can be used at a given time.
  2071. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_UNIFORM_SET:
  2072. .. rst-class:: classref-enumeration-constant
  2073. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURES_PER_UNIFORM_SET** = ``2``
  2074. Maximum number of textures that can be used per uniform set.
  2075. .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET:
  2076. .. rst-class:: classref-enumeration-constant
  2077. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET** = ``3``
  2078. Maximum number of samplers that can be used per uniform set.
  2079. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET:
  2080. .. rst-class:: classref-enumeration-constant
  2081. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET** = ``4``
  2082. Maximum number of `storage buffers <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ per uniform set.
  2083. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET:
  2084. .. rst-class:: classref-enumeration-constant
  2085. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET** = ``5``
  2086. Maximum number of storage images per uniform set.
  2087. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET:
  2088. .. rst-class:: classref-enumeration-constant
  2089. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET** = ``6``
  2090. Maximum number of uniform buffers per uniform set.
  2091. .. _class_RenderingDevice_constant_LIMIT_MAX_DRAW_INDEXED_INDEX:
  2092. .. rst-class:: classref-enumeration-constant
  2093. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_DRAW_INDEXED_INDEX** = ``7``
  2094. Maximum index for an indexed draw command.
  2095. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_HEIGHT:
  2096. .. rst-class:: classref-enumeration-constant
  2097. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_FRAMEBUFFER_HEIGHT** = ``8``
  2098. Maximum height of a framebuffer (in pixels).
  2099. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_WIDTH:
  2100. .. rst-class:: classref-enumeration-constant
  2101. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_FRAMEBUFFER_WIDTH** = ``9``
  2102. Maximum width of a framebuffer (in pixels).
  2103. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_ARRAY_LAYERS:
  2104. .. rst-class:: classref-enumeration-constant
  2105. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_ARRAY_LAYERS** = ``10``
  2106. Maximum number of texture array layers.
  2107. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_1D:
  2108. .. rst-class:: classref-enumeration-constant
  2109. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_1D** = ``11``
  2110. Maximum supported 1-dimensional texture size (in pixels on a single axis).
  2111. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_2D:
  2112. .. rst-class:: classref-enumeration-constant
  2113. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_2D** = ``12``
  2114. Maximum supported 2-dimensional texture size (in pixels on a single axis).
  2115. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_3D:
  2116. .. rst-class:: classref-enumeration-constant
  2117. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_3D** = ``13``
  2118. Maximum supported 3-dimensional texture size (in pixels on a single axis).
  2119. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_CUBE:
  2120. .. rst-class:: classref-enumeration-constant
  2121. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURE_SIZE_CUBE** = ``14``
  2122. Maximum supported cubemap texture size (in pixels on a single axis of a single face).
  2123. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_SHADER_STAGE:
  2124. .. rst-class:: classref-enumeration-constant
  2125. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_TEXTURES_PER_SHADER_STAGE** = ``15``
  2126. Maximum number of textures per shader stage.
  2127. .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE:
  2128. .. rst-class:: classref-enumeration-constant
  2129. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE** = ``16``
  2130. Maximum number of samplers per shader stage.
  2131. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE:
  2132. .. rst-class:: classref-enumeration-constant
  2133. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE** = ``17``
  2134. Maximum number of `storage buffers <https://vkguide.dev/docs/chapter-4/storage_buffers/>`__ per shader stage.
  2135. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE:
  2136. .. rst-class:: classref-enumeration-constant
  2137. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE** = ``18``
  2138. Maximum number of storage images per shader stage.
  2139. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE:
  2140. .. rst-class:: classref-enumeration-constant
  2141. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE** = ``19``
  2142. Maximum number of uniform buffers per uniform set.
  2143. .. _class_RenderingDevice_constant_LIMIT_MAX_PUSH_CONSTANT_SIZE:
  2144. .. rst-class:: classref-enumeration-constant
  2145. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_PUSH_CONSTANT_SIZE** = ``20``
  2146. 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.
  2147. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFER_SIZE:
  2148. .. rst-class:: classref-enumeration-constant
  2149. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_UNIFORM_BUFFER_SIZE** = ``21``
  2150. Maximum size of a uniform buffer.
  2151. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET:
  2152. .. rst-class:: classref-enumeration-constant
  2153. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET** = ``22``
  2154. Maximum vertex input attribute offset.
  2155. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES:
  2156. .. rst-class:: classref-enumeration-constant
  2157. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES** = ``23``
  2158. Maximum number of vertex input attributes.
  2159. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDINGS:
  2160. .. rst-class:: classref-enumeration-constant
  2161. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_BINDINGS** = ``24``
  2162. Maximum number of vertex input bindings.
  2163. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE:
  2164. .. rst-class:: classref-enumeration-constant
  2165. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE** = ``25``
  2166. Maximum vertex input binding stride.
  2167. .. _class_RenderingDevice_constant_LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT:
  2168. .. rst-class:: classref-enumeration-constant
  2169. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT** = ``26``
  2170. Minimum uniform buffer offset alignment.
  2171. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE:
  2172. .. rst-class:: classref-enumeration-constant
  2173. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE** = ``27``
  2174. Maximum shared memory size for compute shaders.
  2175. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X:
  2176. .. rst-class:: classref-enumeration-constant
  2177. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X** = ``28``
  2178. Maximum number of workgroups for compute shaders on the X axis.
  2179. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y:
  2180. .. rst-class:: classref-enumeration-constant
  2181. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y** = ``29``
  2182. Maximum number of workgroups for compute shaders on the Y axis.
  2183. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z:
  2184. .. rst-class:: classref-enumeration-constant
  2185. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z** = ``30``
  2186. Maximum number of workgroups for compute shaders on the Z axis.
  2187. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS:
  2188. .. rst-class:: classref-enumeration-constant
  2189. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS** = ``31``
  2190. Maximum number of workgroup invocations for compute shaders.
  2191. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X:
  2192. .. rst-class:: classref-enumeration-constant
  2193. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X** = ``32``
  2194. Maximum workgroup size for compute shaders on the X axis.
  2195. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y:
  2196. .. rst-class:: classref-enumeration-constant
  2197. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y** = ``33``
  2198. Maximum workgroup size for compute shaders on the Y axis.
  2199. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z:
  2200. .. rst-class:: classref-enumeration-constant
  2201. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z** = ``34``
  2202. Maximum workgroup size for compute shaders on the Z axis.
  2203. .. _class_RenderingDevice_constant_LIMIT_MAX_VIEWPORT_DIMENSIONS_X:
  2204. .. rst-class:: classref-enumeration-constant
  2205. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VIEWPORT_DIMENSIONS_X** = ``35``
  2206. Maximum viewport width (in pixels).
  2207. .. _class_RenderingDevice_constant_LIMIT_MAX_VIEWPORT_DIMENSIONS_Y:
  2208. .. rst-class:: classref-enumeration-constant
  2209. :ref:`Limit<enum_RenderingDevice_Limit>` **LIMIT_MAX_VIEWPORT_DIMENSIONS_Y** = ``36``
  2210. Maximum viewport height (in pixels).
  2211. .. rst-class:: classref-item-separator
  2212. ----
  2213. .. _enum_RenderingDevice_MemoryType:
  2214. .. rst-class:: classref-enumeration
  2215. enum **MemoryType**:
  2216. .. _class_RenderingDevice_constant_MEMORY_TEXTURES:
  2217. .. rst-class:: classref-enumeration-constant
  2218. :ref:`MemoryType<enum_RenderingDevice_MemoryType>` **MEMORY_TEXTURES** = ``0``
  2219. Memory taken by textures.
  2220. .. _class_RenderingDevice_constant_MEMORY_BUFFERS:
  2221. .. rst-class:: classref-enumeration-constant
  2222. :ref:`MemoryType<enum_RenderingDevice_MemoryType>` **MEMORY_BUFFERS** = ``1``
  2223. Memory taken by buffers.
  2224. .. _class_RenderingDevice_constant_MEMORY_TOTAL:
  2225. .. rst-class:: classref-enumeration-constant
  2226. :ref:`MemoryType<enum_RenderingDevice_MemoryType>` **MEMORY_TOTAL** = ``2``
  2227. 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.
  2228. .. rst-class:: classref-section-separator
  2229. ----
  2230. .. rst-class:: classref-descriptions-group
  2231. Constants
  2232. ---------
  2233. .. _class_RenderingDevice_constant_INVALID_ID:
  2234. .. rst-class:: classref-constant
  2235. **INVALID_ID** = ``-1``
  2236. Returned by functions that return an ID if a value is invalid.
  2237. .. _class_RenderingDevice_constant_INVALID_FORMAT_ID:
  2238. .. rst-class:: classref-constant
  2239. **INVALID_FORMAT_ID** = ``-1``
  2240. Returned by functions that return a format ID if a value is invalid.
  2241. .. rst-class:: classref-section-separator
  2242. ----
  2243. .. rst-class:: classref-descriptions-group
  2244. Method Descriptions
  2245. -------------------
  2246. .. _class_RenderingDevice_method_barrier:
  2247. .. rst-class:: classref-method
  2248. void **barrier** **(** |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> from=7, |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> to=7 **)**
  2249. 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.
  2250. .. rst-class:: classref-item-separator
  2251. ----
  2252. .. _class_RenderingDevice_method_buffer_clear:
  2253. .. rst-class:: classref-method
  2254. :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=7 **)**
  2255. Clears the contents of the ``buffer``, clearing ``size_bytes`` bytes, starting at ``offset``. Always raises a memory barrier.
  2256. Prints an error if:
  2257. - the size isn't a multiple of four
  2258. - the region specified by ``offset`` + ``size_bytes`` exceeds the buffer
  2259. - a draw list is currently active (created by :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`)
  2260. - a compute list is currently active (created by :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>`)
  2261. .. rst-class:: classref-item-separator
  2262. ----
  2263. .. _class_RenderingDevice_method_buffer_get_data:
  2264. .. rst-class:: classref-method
  2265. :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 **)**
  2266. 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.
  2267. .. rst-class:: classref-item-separator
  2268. ----
  2269. .. _class_RenderingDevice_method_buffer_update:
  2270. .. rst-class:: classref-method
  2271. :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=7 **)**
  2272. 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>`.
  2273. Prints an error if:
  2274. - the region specified by ``offset`` + ``size_bytes`` exceeds the buffer
  2275. - a draw list is currently active (created by :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`)
  2276. - a compute list is currently active (created by :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>`)
  2277. .. rst-class:: classref-item-separator
  2278. ----
  2279. .. _class_RenderingDevice_method_capture_timestamp:
  2280. .. rst-class:: classref-method
  2281. void **capture_timestamp** **(** :ref:`String<class_String>` name **)**
  2282. 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.
  2283. .. rst-class:: classref-item-separator
  2284. ----
  2285. .. _class_RenderingDevice_method_compute_list_add_barrier:
  2286. .. rst-class:: classref-method
  2287. void **compute_list_add_barrier** **(** :ref:`int<class_int>` compute_list **)**
  2288. Raises a Vulkan compute barrier in the specified ``compute_list``.
  2289. .. rst-class:: classref-item-separator
  2290. ----
  2291. .. _class_RenderingDevice_method_compute_list_begin:
  2292. .. rst-class:: classref-method
  2293. :ref:`int<class_int>` **compute_list_begin** **(** :ref:`bool<class_bool>` allow_draw_overlap=false **)**
  2294. Starts a list of compute commands created with the ``compute_*`` methods. The returned value should be passed to other ``compute_list_*`` functions.
  2295. 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>`.
  2296. A simple compute operation might look like this (code is not a complete example):
  2297. ::
  2298. var rd = RenderingDevice.new()
  2299. var compute_list = rd.compute_list_begin()
  2300. rd.compute_list_bind_compute_pipeline(compute_list, compute_shader_dilate_pipeline)
  2301. rd.compute_list_bind_uniform_set(compute_list, compute_base_uniform_set, 0)
  2302. rd.compute_list_bind_uniform_set(compute_list, dilate_uniform_set, 1)
  2303. for i in atlas_slices:
  2304. rd.compute_list_set_push_constant(compute_list, push_constant, push_constant.size())
  2305. rd.compute_list_dispatch(compute_list, group_size.x, group_size.y, group_size.z)
  2306. # No barrier, let them run all together.
  2307. rd.compute_list_end()
  2308. .. rst-class:: classref-item-separator
  2309. ----
  2310. .. _class_RenderingDevice_method_compute_list_bind_compute_pipeline:
  2311. .. rst-class:: classref-method
  2312. void **compute_list_bind_compute_pipeline** **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` compute_pipeline **)**
  2313. 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>`.
  2314. .. rst-class:: classref-item-separator
  2315. ----
  2316. .. _class_RenderingDevice_method_compute_list_bind_uniform_set:
  2317. .. rst-class:: classref-method
  2318. void **compute_list_bind_uniform_set** **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)**
  2319. 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.
  2320. .. rst-class:: classref-item-separator
  2321. ----
  2322. .. _class_RenderingDevice_method_compute_list_dispatch:
  2323. .. rst-class:: classref-method
  2324. 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 **)**
  2325. 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>`.
  2326. .. rst-class:: classref-item-separator
  2327. ----
  2328. .. _class_RenderingDevice_method_compute_list_end:
  2329. .. rst-class:: classref-method
  2330. void **compute_list_end** **(** |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=7 **)**
  2331. Finishes a list of compute commands created with the ``compute_*`` methods.
  2332. .. rst-class:: classref-item-separator
  2333. ----
  2334. .. _class_RenderingDevice_method_compute_list_set_push_constant:
  2335. .. rst-class:: classref-method
  2336. void **compute_list_set_push_constant** **(** :ref:`int<class_int>` compute_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)**
  2337. 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``).
  2338. .. rst-class:: classref-item-separator
  2339. ----
  2340. .. _class_RenderingDevice_method_compute_pipeline_create:
  2341. .. rst-class:: classref-method
  2342. :ref:`RID<class_RID>` **compute_pipeline_create** **(** :ref:`RID<class_RID>` shader, :ref:`RDPipelineSpecializationConstant[]<class_RDPipelineSpecializationConstant>` specialization_constants=[] **)**
  2343. Creates a new compute pipeline. It can be accessed with the RID that is returned.
  2344. 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.
  2345. .. rst-class:: classref-item-separator
  2346. ----
  2347. .. _class_RenderingDevice_method_compute_pipeline_is_valid:
  2348. .. rst-class:: classref-method
  2349. :ref:`bool<class_bool>` **compute_pipeline_is_valid** **(** :ref:`RID<class_RID>` compute_pipeline **)**
  2350. Returns ``true`` if the compute pipeline specified by the ``compute_pipeline`` RID is valid, ``false`` otherwise.
  2351. .. rst-class:: classref-item-separator
  2352. ----
  2353. .. _class_RenderingDevice_method_create_local_device:
  2354. .. rst-class:: classref-method
  2355. :ref:`RenderingDevice<class_RenderingDevice>` **create_local_device** **(** **)**
  2356. Create a new local **RenderingDevice**. This is most useful for performing compute operations on the GPU independently from the rest of the engine.
  2357. .. rst-class:: classref-item-separator
  2358. ----
  2359. .. _class_RenderingDevice_method_draw_command_begin_label:
  2360. .. rst-class:: classref-method
  2361. void **draw_command_begin_label** **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)**
  2362. 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.
  2363. 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>`.
  2364. .. rst-class:: classref-item-separator
  2365. ----
  2366. .. _class_RenderingDevice_method_draw_command_end_label:
  2367. .. rst-class:: classref-method
  2368. void **draw_command_end_label** **(** **)**
  2369. Ends the command buffer debug label region started by a :ref:`draw_command_begin_label<class_RenderingDevice_method_draw_command_begin_label>` call.
  2370. .. rst-class:: classref-item-separator
  2371. ----
  2372. .. _class_RenderingDevice_method_draw_command_insert_label:
  2373. .. rst-class:: classref-method
  2374. void **draw_command_insert_label** **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)**
  2375. 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.
  2376. .. rst-class:: classref-item-separator
  2377. ----
  2378. .. _class_RenderingDevice_method_draw_list_begin:
  2379. .. rst-class:: classref-method
  2380. :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=[] **)**
  2381. Starts a list of raster drawing commands created with the ``draw_*`` methods. The returned value should be passed to other ``draw_list_*`` functions.
  2382. 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>`.
  2383. A simple drawing operation might look like this (code is not a complete example):
  2384. ::
  2385. var rd = RenderingDevice.new()
  2386. var clear_colors = PackedColorArray([Color(0, 0, 0, 0), Color(0, 0, 0, 0), Color(0, 0, 0, 0)]
  2387. 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)
  2388. # Draw opaque.
  2389. rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline)
  2390. rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
  2391. rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
  2392. rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)
  2393. # Draw wire.
  2394. rd.draw_list_bind_render_pipeline(draw_list, raster_pipeline_wire)
  2395. rd.draw_list_bind_uniform_set(draw_list, raster_base_uniform, 0)
  2396. rd.draw_list_set_push_constant(draw_list, raster_push_constant, raster_push_constant.size())
  2397. rd.draw_list_draw(draw_list, false, 1, slice_triangle_count[i] * 3)
  2398. rd.draw_list_end()
  2399. .. rst-class:: classref-item-separator
  2400. ----
  2401. .. _class_RenderingDevice_method_draw_list_begin_for_screen:
  2402. .. rst-class:: classref-method
  2403. :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) **)**
  2404. High-level variant of :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>`, with the parameters automtaically being adjusted for drawing onto the window specified by the ``screen`` ID.
  2405. \ **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>`.
  2406. .. rst-class:: classref-item-separator
  2407. ----
  2408. .. _class_RenderingDevice_method_draw_list_begin_split:
  2409. .. rst-class:: classref-method
  2410. :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=[] **)**
  2411. 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.
  2412. .. rst-class:: classref-item-separator
  2413. ----
  2414. .. _class_RenderingDevice_method_draw_list_bind_index_array:
  2415. .. rst-class:: classref-method
  2416. void **draw_list_bind_index_array** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` index_array **)**
  2417. Binds ``index_array`` to the specified ``draw_list``.
  2418. .. rst-class:: classref-item-separator
  2419. ----
  2420. .. _class_RenderingDevice_method_draw_list_bind_render_pipeline:
  2421. .. rst-class:: classref-method
  2422. void **draw_list_bind_render_pipeline** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` render_pipeline **)**
  2423. Binds ``render_pipeline`` to the specified ``draw_list``.
  2424. .. rst-class:: classref-item-separator
  2425. ----
  2426. .. _class_RenderingDevice_method_draw_list_bind_uniform_set:
  2427. .. rst-class:: classref-method
  2428. void **draw_list_bind_uniform_set** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)**
  2429. 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.
  2430. .. rst-class:: classref-item-separator
  2431. ----
  2432. .. _class_RenderingDevice_method_draw_list_bind_vertex_array:
  2433. .. rst-class:: classref-method
  2434. void **draw_list_bind_vertex_array** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` vertex_array **)**
  2435. Binds ``vertex_array`` to the specified ``draw_list``.
  2436. .. rst-class:: classref-item-separator
  2437. ----
  2438. .. _class_RenderingDevice_method_draw_list_disable_scissor:
  2439. .. rst-class:: classref-method
  2440. void **draw_list_disable_scissor** **(** :ref:`int<class_int>` draw_list **)**
  2441. 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>`.
  2442. .. rst-class:: classref-item-separator
  2443. ----
  2444. .. _class_RenderingDevice_method_draw_list_draw:
  2445. .. rst-class:: classref-method
  2446. 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 **)**
  2447. Submits ``draw_list`` for rendering on the GPU. This is the raster equivalent to :ref:`compute_list_dispatch<class_RenderingDevice_method_compute_list_dispatch>`.
  2448. .. rst-class:: classref-item-separator
  2449. ----
  2450. .. _class_RenderingDevice_method_draw_list_enable_scissor:
  2451. .. rst-class:: classref-method
  2452. void **draw_list_enable_scissor** **(** :ref:`int<class_int>` draw_list, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)**
  2453. 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>`.
  2454. \ **Note:** The specified ``rect`` is automatically intersected with the screen's dimensions, which means it cannot exceed the screen's dimensions.
  2455. .. rst-class:: classref-item-separator
  2456. ----
  2457. .. _class_RenderingDevice_method_draw_list_end:
  2458. .. rst-class:: classref-method
  2459. void **draw_list_end** **(** |bitfield|\<:ref:`BarrierMask<enum_RenderingDevice_BarrierMask>`\> post_barrier=7 **)**
  2460. Finishes a list of raster drawing commands created with the ``draw_*`` methods.
  2461. .. rst-class:: classref-item-separator
  2462. ----
  2463. .. _class_RenderingDevice_method_draw_list_set_blend_constants:
  2464. .. rst-class:: classref-method
  2465. void **draw_list_set_blend_constants** **(** :ref:`int<class_int>` draw_list, :ref:`Color<class_Color>` color **)**
  2466. 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.
  2467. .. rst-class:: classref-item-separator
  2468. ----
  2469. .. _class_RenderingDevice_method_draw_list_set_push_constant:
  2470. .. rst-class:: classref-method
  2471. void **draw_list_set_push_constant** **(** :ref:`int<class_int>` draw_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)**
  2472. 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``).
  2473. .. rst-class:: classref-item-separator
  2474. ----
  2475. .. _class_RenderingDevice_method_draw_list_switch_to_next_pass:
  2476. .. rst-class:: classref-method
  2477. :ref:`int<class_int>` **draw_list_switch_to_next_pass** **(** **)**
  2478. 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``.
  2479. .. rst-class:: classref-item-separator
  2480. ----
  2481. .. _class_RenderingDevice_method_draw_list_switch_to_next_pass_split:
  2482. .. rst-class:: classref-method
  2483. :ref:`PackedInt64Array<class_PackedInt64Array>` **draw_list_switch_to_next_pass_split** **(** :ref:`int<class_int>` splits **)**
  2484. 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>`.
  2485. .. rst-class:: classref-item-separator
  2486. ----
  2487. .. _class_RenderingDevice_method_framebuffer_create:
  2488. .. rst-class:: classref-method
  2489. :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 **)**
  2490. Creates a new framebuffer. It can be accessed with the RID that is returned.
  2491. 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.
  2492. .. rst-class:: classref-item-separator
  2493. ----
  2494. .. _class_RenderingDevice_method_framebuffer_create_empty:
  2495. .. rst-class:: classref-method
  2496. :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 **)**
  2497. Creates a new empty framebuffer. It can be accessed with the RID that is returned.
  2498. 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.
  2499. .. rst-class:: classref-item-separator
  2500. ----
  2501. .. _class_RenderingDevice_method_framebuffer_create_multipass:
  2502. .. rst-class:: classref-method
  2503. :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 **)**
  2504. Creates a new multipass 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_format_create:
  2509. .. rst-class:: classref-method
  2510. :ref:`int<class_int>` **framebuffer_format_create** **(** :ref:`RDAttachmentFormat[]<class_RDAttachmentFormat>` attachments, :ref:`int<class_int>` view_count=1 **)**
  2511. Creates a new framebuffer format with the specified ``attachments`` and ``view_count``. Returns the new framebuffer's unique framebuffer format ID.
  2512. 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.
  2513. .. rst-class:: classref-item-separator
  2514. ----
  2515. .. _class_RenderingDevice_method_framebuffer_format_create_empty:
  2516. .. rst-class:: classref-method
  2517. :ref:`int<class_int>` **framebuffer_format_create_empty** **(** :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples=0 **)**
  2518. Creates a new empty framebuffer format with the specified number of ``samples`` and returns its ID.
  2519. .. rst-class:: classref-item-separator
  2520. ----
  2521. .. _class_RenderingDevice_method_framebuffer_format_create_multipass:
  2522. .. rst-class:: classref-method
  2523. :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 **)**
  2524. 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.
  2525. .. rst-class:: classref-item-separator
  2526. ----
  2527. .. _class_RenderingDevice_method_framebuffer_format_get_texture_samples:
  2528. .. rst-class:: classref-method
  2529. :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **framebuffer_format_get_texture_samples** **(** :ref:`int<class_int>` format, :ref:`int<class_int>` render_pass=0 **)**
  2530. 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>`).
  2531. .. rst-class:: classref-item-separator
  2532. ----
  2533. .. _class_RenderingDevice_method_framebuffer_get_format:
  2534. .. rst-class:: classref-method
  2535. :ref:`int<class_int>` **framebuffer_get_format** **(** :ref:`RID<class_RID>` framebuffer **)**
  2536. 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.
  2537. .. rst-class:: classref-item-separator
  2538. ----
  2539. .. _class_RenderingDevice_method_framebuffer_is_valid:
  2540. .. rst-class:: classref-method
  2541. :ref:`bool<class_bool>` **framebuffer_is_valid** **(** :ref:`RID<class_RID>` framebuffer **)** |const|
  2542. Returns ``true`` if the framebuffer specified by the ``framebuffer`` RID is valid, ``false`` otherwise.
  2543. .. rst-class:: classref-item-separator
  2544. ----
  2545. .. _class_RenderingDevice_method_free_rid:
  2546. .. rst-class:: classref-method
  2547. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  2548. 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.
  2549. .. rst-class:: classref-item-separator
  2550. ----
  2551. .. _class_RenderingDevice_method_full_barrier:
  2552. .. rst-class:: classref-method
  2553. void **full_barrier** **(** **)**
  2554. 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.
  2555. .. rst-class:: classref-item-separator
  2556. ----
  2557. .. _class_RenderingDevice_method_get_captured_timestamp_cpu_time:
  2558. .. rst-class:: classref-method
  2559. :ref:`int<class_int>` **get_captured_timestamp_cpu_time** **(** :ref:`int<class_int>` index **)** |const|
  2560. 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>`.
  2561. .. rst-class:: classref-item-separator
  2562. ----
  2563. .. _class_RenderingDevice_method_get_captured_timestamp_gpu_time:
  2564. .. rst-class:: classref-method
  2565. :ref:`int<class_int>` **get_captured_timestamp_gpu_time** **(** :ref:`int<class_int>` index **)** |const|
  2566. 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>`.
  2567. .. rst-class:: classref-item-separator
  2568. ----
  2569. .. _class_RenderingDevice_method_get_captured_timestamp_name:
  2570. .. rst-class:: classref-method
  2571. :ref:`String<class_String>` **get_captured_timestamp_name** **(** :ref:`int<class_int>` index **)** |const|
  2572. Returns the timestamp's name for the rendering step specified by ``index``. See also :ref:`capture_timestamp<class_RenderingDevice_method_capture_timestamp>`.
  2573. .. rst-class:: classref-item-separator
  2574. ----
  2575. .. _class_RenderingDevice_method_get_captured_timestamps_count:
  2576. .. rst-class:: classref-method
  2577. :ref:`int<class_int>` **get_captured_timestamps_count** **(** **)** |const|
  2578. Returns the total number of timestamps (rendering steps) available for profiling.
  2579. .. rst-class:: classref-item-separator
  2580. ----
  2581. .. _class_RenderingDevice_method_get_captured_timestamps_frame:
  2582. .. rst-class:: classref-method
  2583. :ref:`int<class_int>` **get_captured_timestamps_frame** **(** **)** |const|
  2584. Returns the index of the last frame rendered that has rendering timestamps available for querying.
  2585. .. rst-class:: classref-item-separator
  2586. ----
  2587. .. _class_RenderingDevice_method_get_device_name:
  2588. .. rst-class:: classref-method
  2589. :ref:`String<class_String>` **get_device_name** **(** **)** |const|
  2590. 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>`.
  2591. .. rst-class:: classref-item-separator
  2592. ----
  2593. .. _class_RenderingDevice_method_get_device_pipeline_cache_uuid:
  2594. .. rst-class:: classref-method
  2595. :ref:`String<class_String>` **get_device_pipeline_cache_uuid** **(** **)** |const|
  2596. 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.
  2597. .. rst-class:: classref-item-separator
  2598. ----
  2599. .. _class_RenderingDevice_method_get_device_vendor_name:
  2600. .. rst-class:: classref-method
  2601. :ref:`String<class_String>` **get_device_vendor_name** **(** **)** |const|
  2602. 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>`.
  2603. .. rst-class:: classref-item-separator
  2604. ----
  2605. .. _class_RenderingDevice_method_get_driver_resource:
  2606. .. rst-class:: classref-method
  2607. :ref:`int<class_int>` **get_driver_resource** **(** :ref:`DriverResource<enum_RenderingDevice_DriverResource>` resource, :ref:`RID<class_RID>` rid, :ref:`int<class_int>` index **)**
  2608. 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.
  2609. .. rst-class:: classref-item-separator
  2610. ----
  2611. .. _class_RenderingDevice_method_get_frame_delay:
  2612. .. rst-class:: classref-method
  2613. :ref:`int<class_int>` **get_frame_delay** **(** **)** |const|
  2614. 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.
  2615. .. rst-class:: classref-item-separator
  2616. ----
  2617. .. _class_RenderingDevice_method_get_memory_usage:
  2618. .. rst-class:: classref-method
  2619. :ref:`int<class_int>` **get_memory_usage** **(** :ref:`MemoryType<enum_RenderingDevice_MemoryType>` type **)** |const|
  2620. 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>`__.
  2621. .. rst-class:: classref-item-separator
  2622. ----
  2623. .. _class_RenderingDevice_method_index_array_create:
  2624. .. rst-class:: classref-method
  2625. :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 **)**
  2626. Creates a new index array. It can be accessed with the RID that is returned.
  2627. 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.
  2628. .. rst-class:: classref-item-separator
  2629. ----
  2630. .. _class_RenderingDevice_method_index_buffer_create:
  2631. .. rst-class:: classref-method
  2632. :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 **)**
  2633. Creates a new index buffer. It can be accessed with the RID that is returned.
  2634. 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.
  2635. .. rst-class:: classref-item-separator
  2636. ----
  2637. .. _class_RenderingDevice_method_limit_get:
  2638. .. rst-class:: classref-method
  2639. :ref:`int<class_int>` **limit_get** **(** :ref:`Limit<enum_RenderingDevice_Limit>` limit **)** |const|
  2640. 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.
  2641. Limits for various graphics hardware can be found in the `Vulkan Hardware Database <https://vulkan.gpuinfo.org/>`__.
  2642. .. rst-class:: classref-item-separator
  2643. ----
  2644. .. _class_RenderingDevice_method_render_pipeline_create:
  2645. .. rst-class:: classref-method
  2646. :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=[] **)**
  2647. Creates a new render pipeline. 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_render_pipeline_is_valid:
  2652. .. rst-class:: classref-method
  2653. :ref:`bool<class_bool>` **render_pipeline_is_valid** **(** :ref:`RID<class_RID>` render_pipeline **)**
  2654. Returns ``true`` if the render pipeline specified by the ``render_pipeline`` RID is valid, ``false`` otherwise.
  2655. .. rst-class:: classref-item-separator
  2656. ----
  2657. .. _class_RenderingDevice_method_sampler_create:
  2658. .. rst-class:: classref-method
  2659. :ref:`RID<class_RID>` **sampler_create** **(** :ref:`RDSamplerState<class_RDSamplerState>` state **)**
  2660. Creates a new sampler. It can be accessed with the RID that is returned.
  2661. 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.
  2662. .. rst-class:: classref-item-separator
  2663. ----
  2664. .. _class_RenderingDevice_method_sampler_is_format_supported_for_filter:
  2665. .. rst-class:: classref-method
  2666. :ref:`bool<class_bool>` **sampler_is_format_supported_for_filter** **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`SamplerFilter<enum_RenderingDevice_SamplerFilter>` sampler_filter **)** |const|
  2667. Returns ``true`` if implementation supports using a texture of ``format`` with the given ``sampler_filter``.
  2668. .. rst-class:: classref-item-separator
  2669. ----
  2670. .. _class_RenderingDevice_method_screen_get_framebuffer_format:
  2671. .. rst-class:: classref-method
  2672. :ref:`int<class_int>` **screen_get_framebuffer_format** **(** **)** |const|
  2673. Returns the screen's framebuffer format.
  2674. \ **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>`.
  2675. .. rst-class:: classref-item-separator
  2676. ----
  2677. .. _class_RenderingDevice_method_screen_get_height:
  2678. .. rst-class:: classref-method
  2679. :ref:`int<class_int>` **screen_get_height** **(** :ref:`int<class_int>` screen=0 **)** |const|
  2680. 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>`.
  2681. \ **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>`.
  2682. .. rst-class:: classref-item-separator
  2683. ----
  2684. .. _class_RenderingDevice_method_screen_get_width:
  2685. .. rst-class:: classref-method
  2686. :ref:`int<class_int>` **screen_get_width** **(** :ref:`int<class_int>` screen=0 **)** |const|
  2687. 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>`.
  2688. \ **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>`.
  2689. .. rst-class:: classref-item-separator
  2690. ----
  2691. .. _class_RenderingDevice_method_set_resource_name:
  2692. .. rst-class:: classref-method
  2693. void **set_resource_name** **(** :ref:`RID<class_RID>` id, :ref:`String<class_String>` name **)**
  2694. Sets the resource name for ``id`` to ``name``. This is used for debugging with third-party tools such as `RenderDoc <https://renderdoc.org/>`__.
  2695. 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.
  2696. \ **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.
  2697. .. rst-class:: classref-item-separator
  2698. ----
  2699. .. _class_RenderingDevice_method_shader_compile_binary_from_spirv:
  2700. .. rst-class:: classref-method
  2701. :ref:`PackedByteArray<class_PackedByteArray>` **shader_compile_binary_from_spirv** **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)**
  2702. 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>`.
  2703. \ ``name`` is an optional human-readable name that can be given to the compiled shader for organizational purposes.
  2704. .. rst-class:: classref-item-separator
  2705. ----
  2706. .. _class_RenderingDevice_method_shader_compile_spirv_from_source:
  2707. .. rst-class:: classref-method
  2708. :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` **shader_compile_spirv_from_source** **(** :ref:`RDShaderSource<class_RDShaderSource>` shader_source, :ref:`bool<class_bool>` allow_cache=true **)**
  2709. 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>`.
  2710. 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.
  2711. .. rst-class:: classref-item-separator
  2712. ----
  2713. .. _class_RenderingDevice_method_shader_create_from_bytecode:
  2714. .. rst-class:: classref-method
  2715. :ref:`RID<class_RID>` **shader_create_from_bytecode** **(** :ref:`PackedByteArray<class_PackedByteArray>` binary_data **)**
  2716. Creates a new shader instance from a binary compiled shader. It can be accessed with the RID that is returned.
  2717. 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>`.
  2718. .. rst-class:: classref-item-separator
  2719. ----
  2720. .. _class_RenderingDevice_method_shader_create_from_spirv:
  2721. .. rst-class:: classref-method
  2722. :ref:`RID<class_RID>` **shader_create_from_spirv** **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)**
  2723. Creates a new shader instance from SPIR-V intermediate code. It can be accessed with the RID that is returned.
  2724. 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>`.
  2725. .. rst-class:: classref-item-separator
  2726. ----
  2727. .. _class_RenderingDevice_method_shader_get_vertex_input_attribute_mask:
  2728. .. rst-class:: classref-method
  2729. :ref:`int<class_int>` **shader_get_vertex_input_attribute_mask** **(** :ref:`RID<class_RID>` shader **)**
  2730. 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).
  2731. .. rst-class:: classref-item-separator
  2732. ----
  2733. .. _class_RenderingDevice_method_storage_buffer_create:
  2734. .. rst-class:: classref-method
  2735. :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 **)**
  2736. 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.
  2737. Once finished with your RID, you will want to free the RID using the RenderingDevice's :ref:`free_rid<class_RenderingDevice_method_free_rid>` method.
  2738. .. rst-class:: classref-item-separator
  2739. ----
  2740. .. _class_RenderingDevice_method_submit:
  2741. .. rst-class:: classref-method
  2742. void **submit** **(** **)**
  2743. 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>`).
  2744. \ **Note:** Only available in local RenderingDevices.
  2745. .. rst-class:: classref-item-separator
  2746. ----
  2747. .. _class_RenderingDevice_method_sync:
  2748. .. rst-class:: classref-method
  2749. void **sync** **(** **)**
  2750. 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.
  2751. \ **Note:** Only available in local RenderingDevices.
  2752. \ **Note:** :ref:`sync<class_RenderingDevice_method_sync>` can only be called after a :ref:`submit<class_RenderingDevice_method_submit>`.
  2753. .. rst-class:: classref-item-separator
  2754. ----
  2755. .. _class_RenderingDevice_method_texture_buffer_create:
  2756. .. rst-class:: classref-method
  2757. :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() **)**
  2758. Creates a new texture buffer. It can be accessed with the RID that is returned.
  2759. 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.
  2760. .. rst-class:: classref-item-separator
  2761. ----
  2762. .. _class_RenderingDevice_method_texture_clear:
  2763. .. rst-class:: classref-method
  2764. :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=7 **)**
  2765. 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`` and ``layer_count`` must both be ``0``.
  2766. \ **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.
  2767. .. rst-class:: classref-item-separator
  2768. ----
  2769. .. _class_RenderingDevice_method_texture_copy:
  2770. .. rst-class:: classref-method
  2771. :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=7 **)**
  2772. 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.
  2773. \ **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.
  2774. \ **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.
  2775. \ **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.
  2776. \ **Note:** ``to_texture`` requires the :ref:`TEXTURE_USAGE_CAN_COPY_TO_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_TO_BIT>` to be retrieved.
  2777. \ **Note:** ``from_texture`` and ``to_texture`` must be of the same type (color or depth).
  2778. .. rst-class:: classref-item-separator
  2779. ----
  2780. .. _class_RenderingDevice_method_texture_create:
  2781. .. rst-class:: classref-method
  2782. :ref:`RID<class_RID>` **texture_create** **(** :ref:`RDTextureFormat<class_RDTextureFormat>` format, :ref:`RDTextureView<class_RDTextureView>` view, :ref:`PackedByteArray[]<class_PackedByteArray>` data=[] **)**
  2783. Creates a new texture. It can be accessed with the RID that is returned.
  2784. 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.
  2785. \ **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.
  2786. .. rst-class:: classref-item-separator
  2787. ----
  2788. .. _class_RenderingDevice_method_texture_create_shared:
  2789. .. rst-class:: classref-method
  2790. :ref:`RID<class_RID>` **texture_create_shared** **(** :ref:`RDTextureView<class_RDTextureView>` view, :ref:`RID<class_RID>` with_texture **)**
  2791. Creates a shared texture using the specified ``view`` and the texture information from ``with_texture``.
  2792. .. rst-class:: classref-item-separator
  2793. ----
  2794. .. _class_RenderingDevice_method_texture_create_shared_from_slice:
  2795. .. rst-class:: classref-method
  2796. :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 **)**
  2797. 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>`\
  2798. For 2D textures (which only have one layer), ``layer`` must be ``0``.
  2799. \ **Note:** Layer slicing is only supported for 2D texture arrays, not 3D textures or cubemaps.
  2800. .. rst-class:: classref-item-separator
  2801. ----
  2802. .. _class_RenderingDevice_method_texture_get_data:
  2803. .. rst-class:: classref-method
  2804. :ref:`PackedByteArray<class_PackedByteArray>` **texture_get_data** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)**
  2805. Returns the ``texture`` data for the specified ``layer`` as raw binary data. For 2D textures (which only have one layer), ``layer`` must be ``0``.
  2806. \ **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.
  2807. \ **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.
  2808. .. rst-class:: classref-item-separator
  2809. ----
  2810. .. _class_RenderingDevice_method_texture_get_native_handle:
  2811. .. rst-class:: classref-method
  2812. :ref:`int<class_int>` **texture_get_native_handle** **(** :ref:`RID<class_RID>` texture **)**
  2813. Returns the internal graphics handle for this texture object. For use when communicating with third-party APIs mostly with GDExtension.
  2814. \ **Note:** This function returns a ``uint64_t`` which internally maps to a ``GLuint`` (OpenGL) or ``VkImage`` (Vulkan).
  2815. .. rst-class:: classref-item-separator
  2816. ----
  2817. .. _class_RenderingDevice_method_texture_is_format_supported_for_usage:
  2818. .. rst-class:: classref-method
  2819. :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|
  2820. Returns ``true`` if the specified ``format`` is supported for the given ``usage_flags``, ``false`` otherwise.
  2821. .. rst-class:: classref-item-separator
  2822. ----
  2823. .. _class_RenderingDevice_method_texture_is_shared:
  2824. .. rst-class:: classref-method
  2825. :ref:`bool<class_bool>` **texture_is_shared** **(** :ref:`RID<class_RID>` texture **)**
  2826. Returns ``true`` if the ``texture`` is shared, ``false`` otherwise. See :ref:`RDTextureView<class_RDTextureView>`.
  2827. .. rst-class:: classref-item-separator
  2828. ----
  2829. .. _class_RenderingDevice_method_texture_is_valid:
  2830. .. rst-class:: classref-method
  2831. :ref:`bool<class_bool>` **texture_is_valid** **(** :ref:`RID<class_RID>` texture **)**
  2832. Returns ``true`` if the ``texture`` is valid, ``false`` otherwise.
  2833. .. rst-class:: classref-item-separator
  2834. ----
  2835. .. _class_RenderingDevice_method_texture_resolve_multisample:
  2836. .. rst-class:: classref-method
  2837. :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=7 **)**
  2838. 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.
  2839. \ **Note:** ``from_texture`` and ``to_texture`` textures must have the same dimension, format and type (color or depth).
  2840. \ **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.
  2841. \ **Note:** ``from_texture`` requires the :ref:`TEXTURE_USAGE_CAN_COPY_FROM_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT>` to be retrieved.
  2842. \ **Note:** ``from_texture`` must be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
  2843. \ **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.
  2844. \ **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.
  2845. \ **Note:** ``to_texture`` texture must **not** be multisampled and must also be 2D (or a slice of a 3D/cubemap texture).
  2846. .. rst-class:: classref-item-separator
  2847. ----
  2848. .. _class_RenderingDevice_method_texture_update:
  2849. .. rst-class:: classref-method
  2850. :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=7 **)**
  2851. 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.
  2852. \ **Note:** Updating textures is forbidden during creation of a draw or compute list.
  2853. \ **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.
  2854. \ **Note:** The existing ``texture`` requires the :ref:`TEXTURE_USAGE_CAN_UPDATE_BIT<class_RenderingDevice_constant_TEXTURE_USAGE_CAN_UPDATE_BIT>` to be updatable.
  2855. .. rst-class:: classref-item-separator
  2856. ----
  2857. .. _class_RenderingDevice_method_uniform_buffer_create:
  2858. .. rst-class:: classref-method
  2859. :ref:`RID<class_RID>` **uniform_buffer_create** **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray() **)**
  2860. Creates a new uniform buffer. It can be accessed with the RID that is returned.
  2861. 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.
  2862. .. rst-class:: classref-item-separator
  2863. ----
  2864. .. _class_RenderingDevice_method_uniform_set_create:
  2865. .. rst-class:: classref-method
  2866. :ref:`RID<class_RID>` **uniform_set_create** **(** :ref:`RDUniform[]<class_RDUniform>` uniforms, :ref:`RID<class_RID>` shader, :ref:`int<class_int>` shader_set **)**
  2867. Creates a new uniform set. It can be accessed with the RID that is returned.
  2868. 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.
  2869. .. rst-class:: classref-item-separator
  2870. ----
  2871. .. _class_RenderingDevice_method_uniform_set_is_valid:
  2872. .. rst-class:: classref-method
  2873. :ref:`bool<class_bool>` **uniform_set_is_valid** **(** :ref:`RID<class_RID>` uniform_set **)**
  2874. Checks if the ``uniform_set`` is valid, i.e. is owned.
  2875. .. rst-class:: classref-item-separator
  2876. ----
  2877. .. _class_RenderingDevice_method_vertex_array_create:
  2878. .. rst-class:: classref-method
  2879. :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() **)**
  2880. Creates a vertex array based on the specified buffers. Optionally, ``offsets`` (in bytes) may be defined for each buffer.
  2881. .. rst-class:: classref-item-separator
  2882. ----
  2883. .. _class_RenderingDevice_method_vertex_buffer_create:
  2884. .. rst-class:: classref-method
  2885. :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 **)**
  2886. It can be accessed with the RID that is returned.
  2887. 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.
  2888. .. rst-class:: classref-item-separator
  2889. ----
  2890. .. _class_RenderingDevice_method_vertex_format_create:
  2891. .. rst-class:: classref-method
  2892. :ref:`int<class_int>` **vertex_format_create** **(** :ref:`RDVertexAttribute[]<class_RDVertexAttribute>` vertex_descriptions **)**
  2893. Creates a new vertex format with the specified ``vertex_descriptions``. Returns a unique vertex format ID corresponding to the newly created vertex format.
  2894. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2895. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2896. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2897. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2898. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2899. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2900. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`