rendering_device_driver_vulkan.cpp 228 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962
  1. /**************************************************************************/
  2. /* rendering_device_driver_vulkan.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "rendering_device_driver_vulkan.h"
  31. #include "core/config/project_settings.h"
  32. #include "core/io/marshalls.h"
  33. #include "thirdparty/misc/smolv.h"
  34. #include "vulkan_hooks.h"
  35. #define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0]))
  36. #define PRINT_NATIVE_COMMANDS 0
  37. /*****************/
  38. /**** GENERIC ****/
  39. /*****************/
  40. static const VkFormat RD_TO_VK_FORMAT[RDD::DATA_FORMAT_MAX] = {
  41. VK_FORMAT_R4G4_UNORM_PACK8,
  42. VK_FORMAT_R4G4B4A4_UNORM_PACK16,
  43. VK_FORMAT_B4G4R4A4_UNORM_PACK16,
  44. VK_FORMAT_R5G6B5_UNORM_PACK16,
  45. VK_FORMAT_B5G6R5_UNORM_PACK16,
  46. VK_FORMAT_R5G5B5A1_UNORM_PACK16,
  47. VK_FORMAT_B5G5R5A1_UNORM_PACK16,
  48. VK_FORMAT_A1R5G5B5_UNORM_PACK16,
  49. VK_FORMAT_R8_UNORM,
  50. VK_FORMAT_R8_SNORM,
  51. VK_FORMAT_R8_USCALED,
  52. VK_FORMAT_R8_SSCALED,
  53. VK_FORMAT_R8_UINT,
  54. VK_FORMAT_R8_SINT,
  55. VK_FORMAT_R8_SRGB,
  56. VK_FORMAT_R8G8_UNORM,
  57. VK_FORMAT_R8G8_SNORM,
  58. VK_FORMAT_R8G8_USCALED,
  59. VK_FORMAT_R8G8_SSCALED,
  60. VK_FORMAT_R8G8_UINT,
  61. VK_FORMAT_R8G8_SINT,
  62. VK_FORMAT_R8G8_SRGB,
  63. VK_FORMAT_R8G8B8_UNORM,
  64. VK_FORMAT_R8G8B8_SNORM,
  65. VK_FORMAT_R8G8B8_USCALED,
  66. VK_FORMAT_R8G8B8_SSCALED,
  67. VK_FORMAT_R8G8B8_UINT,
  68. VK_FORMAT_R8G8B8_SINT,
  69. VK_FORMAT_R8G8B8_SRGB,
  70. VK_FORMAT_B8G8R8_UNORM,
  71. VK_FORMAT_B8G8R8_SNORM,
  72. VK_FORMAT_B8G8R8_USCALED,
  73. VK_FORMAT_B8G8R8_SSCALED,
  74. VK_FORMAT_B8G8R8_UINT,
  75. VK_FORMAT_B8G8R8_SINT,
  76. VK_FORMAT_B8G8R8_SRGB,
  77. VK_FORMAT_R8G8B8A8_UNORM,
  78. VK_FORMAT_R8G8B8A8_SNORM,
  79. VK_FORMAT_R8G8B8A8_USCALED,
  80. VK_FORMAT_R8G8B8A8_SSCALED,
  81. VK_FORMAT_R8G8B8A8_UINT,
  82. VK_FORMAT_R8G8B8A8_SINT,
  83. VK_FORMAT_R8G8B8A8_SRGB,
  84. VK_FORMAT_B8G8R8A8_UNORM,
  85. VK_FORMAT_B8G8R8A8_SNORM,
  86. VK_FORMAT_B8G8R8A8_USCALED,
  87. VK_FORMAT_B8G8R8A8_SSCALED,
  88. VK_FORMAT_B8G8R8A8_UINT,
  89. VK_FORMAT_B8G8R8A8_SINT,
  90. VK_FORMAT_B8G8R8A8_SRGB,
  91. VK_FORMAT_A8B8G8R8_UNORM_PACK32,
  92. VK_FORMAT_A8B8G8R8_SNORM_PACK32,
  93. VK_FORMAT_A8B8G8R8_USCALED_PACK32,
  94. VK_FORMAT_A8B8G8R8_SSCALED_PACK32,
  95. VK_FORMAT_A8B8G8R8_UINT_PACK32,
  96. VK_FORMAT_A8B8G8R8_SINT_PACK32,
  97. VK_FORMAT_A8B8G8R8_SRGB_PACK32,
  98. VK_FORMAT_A2R10G10B10_UNORM_PACK32,
  99. VK_FORMAT_A2R10G10B10_SNORM_PACK32,
  100. VK_FORMAT_A2R10G10B10_USCALED_PACK32,
  101. VK_FORMAT_A2R10G10B10_SSCALED_PACK32,
  102. VK_FORMAT_A2R10G10B10_UINT_PACK32,
  103. VK_FORMAT_A2R10G10B10_SINT_PACK32,
  104. VK_FORMAT_A2B10G10R10_UNORM_PACK32,
  105. VK_FORMAT_A2B10G10R10_SNORM_PACK32,
  106. VK_FORMAT_A2B10G10R10_USCALED_PACK32,
  107. VK_FORMAT_A2B10G10R10_SSCALED_PACK32,
  108. VK_FORMAT_A2B10G10R10_UINT_PACK32,
  109. VK_FORMAT_A2B10G10R10_SINT_PACK32,
  110. VK_FORMAT_R16_UNORM,
  111. VK_FORMAT_R16_SNORM,
  112. VK_FORMAT_R16_USCALED,
  113. VK_FORMAT_R16_SSCALED,
  114. VK_FORMAT_R16_UINT,
  115. VK_FORMAT_R16_SINT,
  116. VK_FORMAT_R16_SFLOAT,
  117. VK_FORMAT_R16G16_UNORM,
  118. VK_FORMAT_R16G16_SNORM,
  119. VK_FORMAT_R16G16_USCALED,
  120. VK_FORMAT_R16G16_SSCALED,
  121. VK_FORMAT_R16G16_UINT,
  122. VK_FORMAT_R16G16_SINT,
  123. VK_FORMAT_R16G16_SFLOAT,
  124. VK_FORMAT_R16G16B16_UNORM,
  125. VK_FORMAT_R16G16B16_SNORM,
  126. VK_FORMAT_R16G16B16_USCALED,
  127. VK_FORMAT_R16G16B16_SSCALED,
  128. VK_FORMAT_R16G16B16_UINT,
  129. VK_FORMAT_R16G16B16_SINT,
  130. VK_FORMAT_R16G16B16_SFLOAT,
  131. VK_FORMAT_R16G16B16A16_UNORM,
  132. VK_FORMAT_R16G16B16A16_SNORM,
  133. VK_FORMAT_R16G16B16A16_USCALED,
  134. VK_FORMAT_R16G16B16A16_SSCALED,
  135. VK_FORMAT_R16G16B16A16_UINT,
  136. VK_FORMAT_R16G16B16A16_SINT,
  137. VK_FORMAT_R16G16B16A16_SFLOAT,
  138. VK_FORMAT_R32_UINT,
  139. VK_FORMAT_R32_SINT,
  140. VK_FORMAT_R32_SFLOAT,
  141. VK_FORMAT_R32G32_UINT,
  142. VK_FORMAT_R32G32_SINT,
  143. VK_FORMAT_R32G32_SFLOAT,
  144. VK_FORMAT_R32G32B32_UINT,
  145. VK_FORMAT_R32G32B32_SINT,
  146. VK_FORMAT_R32G32B32_SFLOAT,
  147. VK_FORMAT_R32G32B32A32_UINT,
  148. VK_FORMAT_R32G32B32A32_SINT,
  149. VK_FORMAT_R32G32B32A32_SFLOAT,
  150. VK_FORMAT_R64_UINT,
  151. VK_FORMAT_R64_SINT,
  152. VK_FORMAT_R64_SFLOAT,
  153. VK_FORMAT_R64G64_UINT,
  154. VK_FORMAT_R64G64_SINT,
  155. VK_FORMAT_R64G64_SFLOAT,
  156. VK_FORMAT_R64G64B64_UINT,
  157. VK_FORMAT_R64G64B64_SINT,
  158. VK_FORMAT_R64G64B64_SFLOAT,
  159. VK_FORMAT_R64G64B64A64_UINT,
  160. VK_FORMAT_R64G64B64A64_SINT,
  161. VK_FORMAT_R64G64B64A64_SFLOAT,
  162. VK_FORMAT_B10G11R11_UFLOAT_PACK32,
  163. VK_FORMAT_E5B9G9R9_UFLOAT_PACK32,
  164. VK_FORMAT_D16_UNORM,
  165. VK_FORMAT_X8_D24_UNORM_PACK32,
  166. VK_FORMAT_D32_SFLOAT,
  167. VK_FORMAT_S8_UINT,
  168. VK_FORMAT_D16_UNORM_S8_UINT,
  169. VK_FORMAT_D24_UNORM_S8_UINT,
  170. VK_FORMAT_D32_SFLOAT_S8_UINT,
  171. VK_FORMAT_BC1_RGB_UNORM_BLOCK,
  172. VK_FORMAT_BC1_RGB_SRGB_BLOCK,
  173. VK_FORMAT_BC1_RGBA_UNORM_BLOCK,
  174. VK_FORMAT_BC1_RGBA_SRGB_BLOCK,
  175. VK_FORMAT_BC2_UNORM_BLOCK,
  176. VK_FORMAT_BC2_SRGB_BLOCK,
  177. VK_FORMAT_BC3_UNORM_BLOCK,
  178. VK_FORMAT_BC3_SRGB_BLOCK,
  179. VK_FORMAT_BC4_UNORM_BLOCK,
  180. VK_FORMAT_BC4_SNORM_BLOCK,
  181. VK_FORMAT_BC5_UNORM_BLOCK,
  182. VK_FORMAT_BC5_SNORM_BLOCK,
  183. VK_FORMAT_BC6H_UFLOAT_BLOCK,
  184. VK_FORMAT_BC6H_SFLOAT_BLOCK,
  185. VK_FORMAT_BC7_UNORM_BLOCK,
  186. VK_FORMAT_BC7_SRGB_BLOCK,
  187. VK_FORMAT_ETC2_R8G8B8_UNORM_BLOCK,
  188. VK_FORMAT_ETC2_R8G8B8_SRGB_BLOCK,
  189. VK_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK,
  190. VK_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK,
  191. VK_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK,
  192. VK_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK,
  193. VK_FORMAT_EAC_R11_UNORM_BLOCK,
  194. VK_FORMAT_EAC_R11_SNORM_BLOCK,
  195. VK_FORMAT_EAC_R11G11_UNORM_BLOCK,
  196. VK_FORMAT_EAC_R11G11_SNORM_BLOCK,
  197. VK_FORMAT_ASTC_4x4_UNORM_BLOCK,
  198. VK_FORMAT_ASTC_4x4_SRGB_BLOCK,
  199. VK_FORMAT_ASTC_5x4_UNORM_BLOCK,
  200. VK_FORMAT_ASTC_5x4_SRGB_BLOCK,
  201. VK_FORMAT_ASTC_5x5_UNORM_BLOCK,
  202. VK_FORMAT_ASTC_5x5_SRGB_BLOCK,
  203. VK_FORMAT_ASTC_6x5_UNORM_BLOCK,
  204. VK_FORMAT_ASTC_6x5_SRGB_BLOCK,
  205. VK_FORMAT_ASTC_6x6_UNORM_BLOCK,
  206. VK_FORMAT_ASTC_6x6_SRGB_BLOCK,
  207. VK_FORMAT_ASTC_8x5_UNORM_BLOCK,
  208. VK_FORMAT_ASTC_8x5_SRGB_BLOCK,
  209. VK_FORMAT_ASTC_8x6_UNORM_BLOCK,
  210. VK_FORMAT_ASTC_8x6_SRGB_BLOCK,
  211. VK_FORMAT_ASTC_8x8_UNORM_BLOCK,
  212. VK_FORMAT_ASTC_8x8_SRGB_BLOCK,
  213. VK_FORMAT_ASTC_10x5_UNORM_BLOCK,
  214. VK_FORMAT_ASTC_10x5_SRGB_BLOCK,
  215. VK_FORMAT_ASTC_10x6_UNORM_BLOCK,
  216. VK_FORMAT_ASTC_10x6_SRGB_BLOCK,
  217. VK_FORMAT_ASTC_10x8_UNORM_BLOCK,
  218. VK_FORMAT_ASTC_10x8_SRGB_BLOCK,
  219. VK_FORMAT_ASTC_10x10_UNORM_BLOCK,
  220. VK_FORMAT_ASTC_10x10_SRGB_BLOCK,
  221. VK_FORMAT_ASTC_12x10_UNORM_BLOCK,
  222. VK_FORMAT_ASTC_12x10_SRGB_BLOCK,
  223. VK_FORMAT_ASTC_12x12_UNORM_BLOCK,
  224. VK_FORMAT_ASTC_12x12_SRGB_BLOCK,
  225. VK_FORMAT_G8B8G8R8_422_UNORM,
  226. VK_FORMAT_B8G8R8G8_422_UNORM,
  227. VK_FORMAT_G8_B8_R8_3PLANE_420_UNORM,
  228. VK_FORMAT_G8_B8R8_2PLANE_420_UNORM,
  229. VK_FORMAT_G8_B8_R8_3PLANE_422_UNORM,
  230. VK_FORMAT_G8_B8R8_2PLANE_422_UNORM,
  231. VK_FORMAT_G8_B8_R8_3PLANE_444_UNORM,
  232. VK_FORMAT_R10X6_UNORM_PACK16,
  233. VK_FORMAT_R10X6G10X6_UNORM_2PACK16,
  234. VK_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16,
  235. VK_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16,
  236. VK_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16,
  237. VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16,
  238. VK_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16,
  239. VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16,
  240. VK_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16,
  241. VK_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16,
  242. VK_FORMAT_R12X4_UNORM_PACK16,
  243. VK_FORMAT_R12X4G12X4_UNORM_2PACK16,
  244. VK_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16,
  245. VK_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16,
  246. VK_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16,
  247. VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16,
  248. VK_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16,
  249. VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16,
  250. VK_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16,
  251. VK_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16,
  252. VK_FORMAT_G16B16G16R16_422_UNORM,
  253. VK_FORMAT_B16G16R16G16_422_UNORM,
  254. VK_FORMAT_G16_B16_R16_3PLANE_420_UNORM,
  255. VK_FORMAT_G16_B16R16_2PLANE_420_UNORM,
  256. VK_FORMAT_G16_B16_R16_3PLANE_422_UNORM,
  257. VK_FORMAT_G16_B16R16_2PLANE_422_UNORM,
  258. VK_FORMAT_G16_B16_R16_3PLANE_444_UNORM,
  259. };
  260. // RDD::CompareOperator == VkCompareOp.
  261. static_assert(ENUM_MEMBERS_EQUAL(RDD::COMPARE_OP_NEVER, VK_COMPARE_OP_NEVER));
  262. static_assert(ENUM_MEMBERS_EQUAL(RDD::COMPARE_OP_LESS, VK_COMPARE_OP_LESS));
  263. static_assert(ENUM_MEMBERS_EQUAL(RDD::COMPARE_OP_EQUAL, VK_COMPARE_OP_EQUAL));
  264. static_assert(ENUM_MEMBERS_EQUAL(RDD::COMPARE_OP_LESS_OR_EQUAL, VK_COMPARE_OP_LESS_OR_EQUAL));
  265. static_assert(ENUM_MEMBERS_EQUAL(RDD::COMPARE_OP_GREATER, VK_COMPARE_OP_GREATER));
  266. static_assert(ENUM_MEMBERS_EQUAL(RDD::COMPARE_OP_NOT_EQUAL, VK_COMPARE_OP_NOT_EQUAL));
  267. static_assert(ENUM_MEMBERS_EQUAL(RDD::COMPARE_OP_GREATER_OR_EQUAL, VK_COMPARE_OP_GREATER_OR_EQUAL));
  268. static_assert(ENUM_MEMBERS_EQUAL(RDD::COMPARE_OP_ALWAYS, VK_COMPARE_OP_ALWAYS));
  269. static_assert(ARRAYS_COMPATIBLE_FIELDWISE(Rect2i, VkRect2D));
  270. uint32_t RenderingDeviceDriverVulkan::SubgroupCapabilities::supported_stages_flags_rd() const {
  271. uint32_t flags = 0;
  272. if (supported_stages & VK_SHADER_STAGE_VERTEX_BIT) {
  273. flags += SHADER_STAGE_VERTEX_BIT;
  274. }
  275. if (supported_stages & VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT) {
  276. flags += SHADER_STAGE_TESSELATION_CONTROL_BIT;
  277. }
  278. if (supported_stages & VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT) {
  279. flags += SHADER_STAGE_TESSELATION_EVALUATION_BIT;
  280. }
  281. if (supported_stages & VK_SHADER_STAGE_GEOMETRY_BIT) {
  282. // FIXME: Add shader stage geometry bit.
  283. }
  284. if (supported_stages & VK_SHADER_STAGE_FRAGMENT_BIT) {
  285. flags += SHADER_STAGE_FRAGMENT_BIT;
  286. }
  287. if (supported_stages & VK_SHADER_STAGE_COMPUTE_BIT) {
  288. flags += SHADER_STAGE_COMPUTE_BIT;
  289. }
  290. return flags;
  291. }
  292. String RenderingDeviceDriverVulkan::SubgroupCapabilities::supported_stages_desc() const {
  293. String res;
  294. if (supported_stages & VK_SHADER_STAGE_VERTEX_BIT) {
  295. res += ", STAGE_VERTEX";
  296. }
  297. if (supported_stages & VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT) {
  298. res += ", STAGE_TESSELLATION_CONTROL";
  299. }
  300. if (supported_stages & VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT) {
  301. res += ", STAGE_TESSELLATION_EVALUATION";
  302. }
  303. if (supported_stages & VK_SHADER_STAGE_GEOMETRY_BIT) {
  304. res += ", STAGE_GEOMETRY";
  305. }
  306. if (supported_stages & VK_SHADER_STAGE_FRAGMENT_BIT) {
  307. res += ", STAGE_FRAGMENT";
  308. }
  309. if (supported_stages & VK_SHADER_STAGE_COMPUTE_BIT) {
  310. res += ", STAGE_COMPUTE";
  311. }
  312. // These are not defined on Android GRMBL.
  313. if (supported_stages & 0x00000100 /* VK_SHADER_STAGE_RAYGEN_BIT_KHR */) {
  314. res += ", STAGE_RAYGEN_KHR";
  315. }
  316. if (supported_stages & 0x00000200 /* VK_SHADER_STAGE_ANY_HIT_BIT_KHR */) {
  317. res += ", STAGE_ANY_HIT_KHR";
  318. }
  319. if (supported_stages & 0x00000400 /* VK_SHADER_STAGE_CLOSEST_HIT_BIT_KHR */) {
  320. res += ", STAGE_CLOSEST_HIT_KHR";
  321. }
  322. if (supported_stages & 0x00000800 /* VK_SHADER_STAGE_MISS_BIT_KHR */) {
  323. res += ", STAGE_MISS_KHR";
  324. }
  325. if (supported_stages & 0x00001000 /* VK_SHADER_STAGE_INTERSECTION_BIT_KHR */) {
  326. res += ", STAGE_INTERSECTION_KHR";
  327. }
  328. if (supported_stages & 0x00002000 /* VK_SHADER_STAGE_CALLABLE_BIT_KHR */) {
  329. res += ", STAGE_CALLABLE_KHR";
  330. }
  331. if (supported_stages & 0x00000040 /* VK_SHADER_STAGE_TASK_BIT_NV */) {
  332. res += ", STAGE_TASK_NV";
  333. }
  334. if (supported_stages & 0x00000080 /* VK_SHADER_STAGE_MESH_BIT_NV */) {
  335. res += ", STAGE_MESH_NV";
  336. }
  337. return res.substr(2); // Remove first ", ".
  338. }
  339. uint32_t RenderingDeviceDriverVulkan::SubgroupCapabilities::supported_operations_flags_rd() const {
  340. uint32_t flags = 0;
  341. if (supported_operations & VK_SUBGROUP_FEATURE_BASIC_BIT) {
  342. flags += SUBGROUP_BASIC_BIT;
  343. }
  344. if (supported_operations & VK_SUBGROUP_FEATURE_VOTE_BIT) {
  345. flags += SUBGROUP_VOTE_BIT;
  346. }
  347. if (supported_operations & VK_SUBGROUP_FEATURE_ARITHMETIC_BIT) {
  348. flags += SUBGROUP_ARITHMETIC_BIT;
  349. }
  350. if (supported_operations & VK_SUBGROUP_FEATURE_BALLOT_BIT) {
  351. flags += SUBGROUP_BALLOT_BIT;
  352. }
  353. if (supported_operations & VK_SUBGROUP_FEATURE_SHUFFLE_BIT) {
  354. flags += SUBGROUP_SHUFFLE_BIT;
  355. }
  356. if (supported_operations & VK_SUBGROUP_FEATURE_SHUFFLE_RELATIVE_BIT) {
  357. flags += SUBGROUP_SHUFFLE_RELATIVE_BIT;
  358. }
  359. if (supported_operations & VK_SUBGROUP_FEATURE_CLUSTERED_BIT) {
  360. flags += SUBGROUP_CLUSTERED_BIT;
  361. }
  362. if (supported_operations & VK_SUBGROUP_FEATURE_QUAD_BIT) {
  363. flags += SUBGROUP_QUAD_BIT;
  364. }
  365. return flags;
  366. }
  367. String RenderingDeviceDriverVulkan::SubgroupCapabilities::supported_operations_desc() const {
  368. String res;
  369. if (supported_operations & VK_SUBGROUP_FEATURE_BASIC_BIT) {
  370. res += ", FEATURE_BASIC";
  371. }
  372. if (supported_operations & VK_SUBGROUP_FEATURE_VOTE_BIT) {
  373. res += ", FEATURE_VOTE";
  374. }
  375. if (supported_operations & VK_SUBGROUP_FEATURE_ARITHMETIC_BIT) {
  376. res += ", FEATURE_ARITHMETIC";
  377. }
  378. if (supported_operations & VK_SUBGROUP_FEATURE_BALLOT_BIT) {
  379. res += ", FEATURE_BALLOT";
  380. }
  381. if (supported_operations & VK_SUBGROUP_FEATURE_SHUFFLE_BIT) {
  382. res += ", FEATURE_SHUFFLE";
  383. }
  384. if (supported_operations & VK_SUBGROUP_FEATURE_SHUFFLE_RELATIVE_BIT) {
  385. res += ", FEATURE_SHUFFLE_RELATIVE";
  386. }
  387. if (supported_operations & VK_SUBGROUP_FEATURE_CLUSTERED_BIT) {
  388. res += ", FEATURE_CLUSTERED";
  389. }
  390. if (supported_operations & VK_SUBGROUP_FEATURE_QUAD_BIT) {
  391. res += ", FEATURE_QUAD";
  392. }
  393. if (supported_operations & VK_SUBGROUP_FEATURE_PARTITIONED_BIT_NV) {
  394. res += ", FEATURE_PARTITIONED_NV";
  395. }
  396. return res.substr(2); // Remove first ", ".
  397. }
  398. /*****************/
  399. /**** GENERIC ****/
  400. /*****************/
  401. void RenderingDeviceDriverVulkan::_register_requested_device_extension(const CharString &p_extension_name, bool p_required) {
  402. ERR_FAIL_COND(requested_device_extensions.has(p_extension_name));
  403. requested_device_extensions[p_extension_name] = p_required;
  404. }
  405. Error RenderingDeviceDriverVulkan::_initialize_device_extensions() {
  406. enabled_device_extension_names.clear();
  407. _register_requested_device_extension(VK_KHR_SWAPCHAIN_EXTENSION_NAME, true);
  408. _register_requested_device_extension(VK_KHR_MULTIVIEW_EXTENSION_NAME, false);
  409. _register_requested_device_extension(VK_KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME, false);
  410. _register_requested_device_extension(VK_KHR_CREATE_RENDERPASS_2_EXTENSION_NAME, false);
  411. _register_requested_device_extension(VK_KHR_SHADER_FLOAT16_INT8_EXTENSION_NAME, false);
  412. _register_requested_device_extension(VK_KHR_STORAGE_BUFFER_STORAGE_CLASS_EXTENSION_NAME, false);
  413. _register_requested_device_extension(VK_KHR_16BIT_STORAGE_EXTENSION_NAME, false);
  414. _register_requested_device_extension(VK_KHR_IMAGE_FORMAT_LIST_EXTENSION_NAME, false);
  415. _register_requested_device_extension(VK_KHR_MAINTENANCE_2_EXTENSION_NAME, false);
  416. _register_requested_device_extension(VK_EXT_PIPELINE_CREATION_CACHE_CONTROL_EXTENSION_NAME, false);
  417. _register_requested_device_extension(VK_EXT_SUBGROUP_SIZE_CONTROL_EXTENSION_NAME, false);
  418. if (Engine::get_singleton()->is_generate_spirv_debug_info_enabled()) {
  419. _register_requested_device_extension(VK_KHR_SHADER_NON_SEMANTIC_INFO_EXTENSION_NAME, true);
  420. }
  421. uint32_t device_extension_count = 0;
  422. VkResult err = vkEnumerateDeviceExtensionProperties(physical_device, nullptr, &device_extension_count, nullptr);
  423. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  424. ERR_FAIL_COND_V_MSG(device_extension_count == 0, ERR_CANT_CREATE, "vkEnumerateDeviceExtensionProperties failed to find any extensions\n\nDo you have a compatible Vulkan installable client driver (ICD) installed?");
  425. TightLocalVector<VkExtensionProperties> device_extensions;
  426. device_extensions.resize(device_extension_count);
  427. err = vkEnumerateDeviceExtensionProperties(physical_device, nullptr, &device_extension_count, device_extensions.ptr());
  428. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  429. #ifdef DEV_ENABLED
  430. for (uint32_t i = 0; i < device_extension_count; i++) {
  431. print_verbose(String("VULKAN: Found device extension ") + String::utf8(device_extensions[i].extensionName));
  432. }
  433. #endif
  434. // Enable all extensions that are supported and requested.
  435. for (uint32_t i = 0; i < device_extension_count; i++) {
  436. CharString extension_name(device_extensions[i].extensionName);
  437. if (requested_device_extensions.has(extension_name)) {
  438. enabled_device_extension_names.insert(extension_name);
  439. }
  440. }
  441. // Now check our requested extensions.
  442. for (KeyValue<CharString, bool> &requested_extension : requested_device_extensions) {
  443. if (!enabled_device_extension_names.has(requested_extension.key)) {
  444. if (requested_extension.value) {
  445. ERR_FAIL_V_MSG(ERR_BUG, String("Required extension ") + String::utf8(requested_extension.key) + String(" not found."));
  446. } else {
  447. print_verbose(String("Optional extension ") + String::utf8(requested_extension.key) + String(" not found"));
  448. }
  449. }
  450. }
  451. return OK;
  452. }
  453. Error RenderingDeviceDriverVulkan::_check_device_features() {
  454. vkGetPhysicalDeviceFeatures(physical_device, &physical_device_features);
  455. // Check for required features.
  456. if (!physical_device_features.imageCubeArray || !physical_device_features.independentBlend) {
  457. String error_string = vformat("Your GPU (%s) does not support the following features which are required to use Vulkan-based renderers in Godot:\n\n", context_device.name);
  458. if (!physical_device_features.imageCubeArray) {
  459. error_string += "- No support for image cube arrays.\n";
  460. }
  461. if (!physical_device_features.independentBlend) {
  462. error_string += "- No support for independentBlend.\n";
  463. }
  464. error_string += "\nThis is usually a hardware limitation, so updating graphics drivers won't help in most cases.";
  465. #if defined(ANDROID_ENABLED) || defined(IOS_ENABLED)
  466. // Android/iOS platform ports currently don't exit themselves when this method returns `ERR_CANT_CREATE`.
  467. OS::get_singleton()->alert(error_string + "\nClick OK to exit (black screen will be visible).");
  468. #else
  469. OS::get_singleton()->alert(error_string + "\nClick OK to exit.");
  470. #endif
  471. return ERR_CANT_CREATE;
  472. }
  473. // Opt-in to the features we actually need/use. These can be changed in the future.
  474. // We do this for multiple reasons:
  475. //
  476. // 1. Certain features (like sparse* stuff) cause unnecessary internal driver allocations.
  477. // 2. Others like shaderStorageImageMultisample are a huge red flag
  478. // (MSAA + Storage is rarely needed).
  479. // 3. Most features when turned off aren't actually off (we just promise the driver not to use them)
  480. // and it is validation what will complain. This allows us to target a minimum baseline.
  481. //
  482. // TODO: Allow the user to override these settings (i.e. turn off more stuff) using profiles
  483. // so they can target a broad range of HW. For example Mali HW does not have
  484. // shaderClipDistance/shaderCullDistance; thus validation would complain if such feature is used;
  485. // allowing them to fix the problem without even owning Mali HW to test on.
  486. //
  487. // The excluded features are:
  488. // - robustBufferAccess (can hamper performance on some hardware)
  489. // - occlusionQueryPrecise
  490. // - pipelineStatisticsQuery
  491. // - shaderStorageImageMultisample (unsupported by Intel Arc, prevents from using MSAA storage accidentally)
  492. // - shaderResourceResidency
  493. // - sparseBinding (we don't use sparse features and enabling them cause extra internal allocations inside the Vulkan driver we don't need)
  494. // - sparseResidencyBuffer
  495. // - sparseResidencyImage2D
  496. // - sparseResidencyImage3D
  497. // - sparseResidency2Samples
  498. // - sparseResidency4Samples
  499. // - sparseResidency8Samples
  500. // - sparseResidency16Samples
  501. // - sparseResidencyAliased
  502. // - inheritedQueries
  503. #define VK_DEVICEFEATURE_ENABLE_IF(x) \
  504. if (physical_device_features.x) { \
  505. requested_device_features.x = physical_device_features.x; \
  506. } else \
  507. ((void)0)
  508. requested_device_features = {};
  509. VK_DEVICEFEATURE_ENABLE_IF(fullDrawIndexUint32);
  510. VK_DEVICEFEATURE_ENABLE_IF(imageCubeArray);
  511. VK_DEVICEFEATURE_ENABLE_IF(independentBlend);
  512. VK_DEVICEFEATURE_ENABLE_IF(geometryShader);
  513. VK_DEVICEFEATURE_ENABLE_IF(tessellationShader);
  514. VK_DEVICEFEATURE_ENABLE_IF(sampleRateShading);
  515. VK_DEVICEFEATURE_ENABLE_IF(dualSrcBlend);
  516. VK_DEVICEFEATURE_ENABLE_IF(logicOp);
  517. VK_DEVICEFEATURE_ENABLE_IF(multiDrawIndirect);
  518. VK_DEVICEFEATURE_ENABLE_IF(drawIndirectFirstInstance);
  519. VK_DEVICEFEATURE_ENABLE_IF(depthClamp);
  520. VK_DEVICEFEATURE_ENABLE_IF(depthBiasClamp);
  521. VK_DEVICEFEATURE_ENABLE_IF(fillModeNonSolid);
  522. VK_DEVICEFEATURE_ENABLE_IF(depthBounds);
  523. VK_DEVICEFEATURE_ENABLE_IF(wideLines);
  524. VK_DEVICEFEATURE_ENABLE_IF(largePoints);
  525. VK_DEVICEFEATURE_ENABLE_IF(alphaToOne);
  526. VK_DEVICEFEATURE_ENABLE_IF(multiViewport);
  527. VK_DEVICEFEATURE_ENABLE_IF(samplerAnisotropy);
  528. VK_DEVICEFEATURE_ENABLE_IF(textureCompressionETC2);
  529. VK_DEVICEFEATURE_ENABLE_IF(textureCompressionASTC_LDR);
  530. VK_DEVICEFEATURE_ENABLE_IF(textureCompressionBC);
  531. VK_DEVICEFEATURE_ENABLE_IF(vertexPipelineStoresAndAtomics);
  532. VK_DEVICEFEATURE_ENABLE_IF(fragmentStoresAndAtomics);
  533. VK_DEVICEFEATURE_ENABLE_IF(shaderTessellationAndGeometryPointSize);
  534. VK_DEVICEFEATURE_ENABLE_IF(shaderImageGatherExtended);
  535. VK_DEVICEFEATURE_ENABLE_IF(shaderStorageImageExtendedFormats);
  536. VK_DEVICEFEATURE_ENABLE_IF(shaderStorageImageReadWithoutFormat);
  537. VK_DEVICEFEATURE_ENABLE_IF(shaderStorageImageWriteWithoutFormat);
  538. VK_DEVICEFEATURE_ENABLE_IF(shaderUniformBufferArrayDynamicIndexing);
  539. VK_DEVICEFEATURE_ENABLE_IF(shaderSampledImageArrayDynamicIndexing);
  540. VK_DEVICEFEATURE_ENABLE_IF(shaderStorageBufferArrayDynamicIndexing);
  541. VK_DEVICEFEATURE_ENABLE_IF(shaderStorageImageArrayDynamicIndexing);
  542. VK_DEVICEFEATURE_ENABLE_IF(shaderClipDistance);
  543. VK_DEVICEFEATURE_ENABLE_IF(shaderCullDistance);
  544. VK_DEVICEFEATURE_ENABLE_IF(shaderFloat64);
  545. VK_DEVICEFEATURE_ENABLE_IF(shaderInt64);
  546. VK_DEVICEFEATURE_ENABLE_IF(shaderInt16);
  547. VK_DEVICEFEATURE_ENABLE_IF(shaderResourceMinLod);
  548. VK_DEVICEFEATURE_ENABLE_IF(variableMultisampleRate);
  549. return OK;
  550. }
  551. Error RenderingDeviceDriverVulkan::_check_device_capabilities() {
  552. // Fill device family and version.
  553. device_capabilities.device_family = DEVICE_VULKAN;
  554. device_capabilities.version_major = VK_API_VERSION_MAJOR(physical_device_properties.apiVersion);
  555. device_capabilities.version_minor = VK_API_VERSION_MINOR(physical_device_properties.apiVersion);
  556. // References:
  557. // https://www.khronos.org/registry/vulkan/specs/1.2-extensions/man/html/VK_KHR_multiview.html
  558. // https://www.khronos.org/blog/vulkan-subgroup-tutorial
  559. const RenderingContextDriverVulkan::Functions &functions = context_driver->functions_get();
  560. if (functions.GetPhysicalDeviceFeatures2 != nullptr) {
  561. // We must check that the corresponding extension is present before assuming a feature as enabled.
  562. // See also: https://github.com/godotengine/godot/issues/65409
  563. void *next_features = nullptr;
  564. VkPhysicalDeviceVulkan12Features device_features_vk_1_2 = {};
  565. VkPhysicalDeviceShaderFloat16Int8FeaturesKHR shader_features = {};
  566. VkPhysicalDeviceFragmentShadingRateFeaturesKHR vrs_features = {};
  567. VkPhysicalDevice16BitStorageFeaturesKHR storage_feature = {};
  568. VkPhysicalDeviceMultiviewFeatures multiview_features = {};
  569. VkPhysicalDevicePipelineCreationCacheControlFeatures pipeline_cache_control_features = {};
  570. const bool use_1_2_features = physical_device_properties.apiVersion >= VK_API_VERSION_1_2;
  571. if (use_1_2_features) {
  572. device_features_vk_1_2.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VULKAN_1_2_FEATURES;
  573. device_features_vk_1_2.pNext = next_features;
  574. next_features = &device_features_vk_1_2;
  575. } else if (enabled_device_extension_names.has(VK_KHR_SHADER_FLOAT16_INT8_EXTENSION_NAME)) {
  576. shader_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_FLOAT16_INT8_FEATURES_KHR;
  577. shader_features.pNext = next_features;
  578. next_features = &shader_features;
  579. }
  580. if (enabled_device_extension_names.has(VK_KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME)) {
  581. vrs_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR;
  582. vrs_features.pNext = next_features;
  583. next_features = &vrs_features;
  584. }
  585. if (enabled_device_extension_names.has(VK_KHR_16BIT_STORAGE_EXTENSION_NAME)) {
  586. storage_feature.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_16BIT_STORAGE_FEATURES_KHR;
  587. storage_feature.pNext = next_features;
  588. next_features = &storage_feature;
  589. }
  590. if (enabled_device_extension_names.has(VK_KHR_MULTIVIEW_EXTENSION_NAME)) {
  591. multiview_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_FEATURES;
  592. multiview_features.pNext = next_features;
  593. next_features = &multiview_features;
  594. }
  595. if (enabled_device_extension_names.has(VK_EXT_PIPELINE_CREATION_CACHE_CONTROL_EXTENSION_NAME)) {
  596. pipeline_cache_control_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_CREATION_CACHE_CONTROL_FEATURES;
  597. pipeline_cache_control_features.pNext = next_features;
  598. next_features = &pipeline_cache_control_features;
  599. }
  600. VkPhysicalDeviceFeatures2 device_features_2 = {};
  601. device_features_2.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FEATURES_2;
  602. device_features_2.pNext = next_features;
  603. functions.GetPhysicalDeviceFeatures2(physical_device, &device_features_2);
  604. if (use_1_2_features) {
  605. #ifdef MACOS_ENABLED
  606. ERR_FAIL_COND_V_MSG(!device_features_vk_1_2.shaderSampledImageArrayNonUniformIndexing, ERR_CANT_CREATE, "Your GPU doesn't support shaderSampledImageArrayNonUniformIndexing which is required to use the Vulkan-based renderers in Godot.");
  607. #endif
  608. if (enabled_device_extension_names.has(VK_KHR_SHADER_FLOAT16_INT8_EXTENSION_NAME)) {
  609. shader_capabilities.shader_float16_is_supported = device_features_vk_1_2.shaderFloat16;
  610. shader_capabilities.shader_int8_is_supported = device_features_vk_1_2.shaderInt8;
  611. }
  612. } else {
  613. if (enabled_device_extension_names.has(VK_KHR_SHADER_FLOAT16_INT8_EXTENSION_NAME)) {
  614. shader_capabilities.shader_float16_is_supported = shader_features.shaderFloat16;
  615. shader_capabilities.shader_int8_is_supported = shader_features.shaderInt8;
  616. }
  617. }
  618. if (enabled_device_extension_names.has(VK_KHR_FRAGMENT_SHADING_RATE_EXTENSION_NAME)) {
  619. vrs_capabilities.pipeline_vrs_supported = vrs_features.pipelineFragmentShadingRate;
  620. vrs_capabilities.primitive_vrs_supported = vrs_features.primitiveFragmentShadingRate;
  621. vrs_capabilities.attachment_vrs_supported = vrs_features.attachmentFragmentShadingRate;
  622. }
  623. if (enabled_device_extension_names.has(VK_KHR_MULTIVIEW_EXTENSION_NAME)) {
  624. multiview_capabilities.is_supported = multiview_features.multiview;
  625. multiview_capabilities.geometry_shader_is_supported = multiview_features.multiviewGeometryShader;
  626. multiview_capabilities.tessellation_shader_is_supported = multiview_features.multiviewTessellationShader;
  627. }
  628. if (enabled_device_extension_names.has(VK_KHR_16BIT_STORAGE_EXTENSION_NAME)) {
  629. storage_buffer_capabilities.storage_buffer_16_bit_access_is_supported = storage_feature.storageBuffer16BitAccess;
  630. storage_buffer_capabilities.uniform_and_storage_buffer_16_bit_access_is_supported = storage_feature.uniformAndStorageBuffer16BitAccess;
  631. storage_buffer_capabilities.storage_push_constant_16_is_supported = storage_feature.storagePushConstant16;
  632. storage_buffer_capabilities.storage_input_output_16 = storage_feature.storageInputOutput16;
  633. }
  634. if (enabled_device_extension_names.has(VK_EXT_PIPELINE_CREATION_CACHE_CONTROL_EXTENSION_NAME)) {
  635. pipeline_cache_control_support = pipeline_cache_control_features.pipelineCreationCacheControl;
  636. }
  637. }
  638. if (functions.GetPhysicalDeviceProperties2 != nullptr) {
  639. void *next_properties = nullptr;
  640. VkPhysicalDeviceFragmentShadingRatePropertiesKHR vrs_properties = {};
  641. VkPhysicalDeviceMultiviewProperties multiview_properties = {};
  642. VkPhysicalDeviceSubgroupProperties subgroup_properties = {};
  643. VkPhysicalDeviceSubgroupSizeControlProperties subgroup_size_control_properties = {};
  644. VkPhysicalDeviceProperties2 physical_device_properties_2 = {};
  645. const bool use_1_1_properties = physical_device_properties.apiVersion >= VK_API_VERSION_1_1;
  646. if (use_1_1_properties) {
  647. subgroup_properties.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SUBGROUP_PROPERTIES;
  648. subgroup_properties.pNext = next_properties;
  649. next_properties = &subgroup_properties;
  650. subgroup_capabilities.size_control_is_supported = enabled_device_extension_names.has(VK_EXT_SUBGROUP_SIZE_CONTROL_EXTENSION_NAME);
  651. if (subgroup_capabilities.size_control_is_supported) {
  652. subgroup_size_control_properties.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SUBGROUP_SIZE_CONTROL_PROPERTIES;
  653. subgroup_size_control_properties.pNext = next_properties;
  654. next_properties = &subgroup_size_control_properties;
  655. }
  656. }
  657. if (multiview_capabilities.is_supported) {
  658. multiview_properties.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_PROPERTIES;
  659. multiview_properties.pNext = next_properties;
  660. next_properties = &multiview_properties;
  661. }
  662. if (vrs_capabilities.attachment_vrs_supported) {
  663. vrs_properties.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_PROPERTIES_KHR;
  664. vrs_properties.pNext = next_properties;
  665. next_properties = &vrs_properties;
  666. }
  667. physical_device_properties_2.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PROPERTIES_2;
  668. physical_device_properties_2.pNext = next_properties;
  669. functions.GetPhysicalDeviceProperties2(physical_device, &physical_device_properties_2);
  670. subgroup_capabilities.size = subgroup_properties.subgroupSize;
  671. subgroup_capabilities.min_size = subgroup_properties.subgroupSize;
  672. subgroup_capabilities.max_size = subgroup_properties.subgroupSize;
  673. subgroup_capabilities.supported_stages = subgroup_properties.supportedStages;
  674. subgroup_capabilities.supported_operations = subgroup_properties.supportedOperations;
  675. // Note: quadOperationsInAllStages will be true if:
  676. // - supportedStages has VK_SHADER_STAGE_ALL_GRAPHICS + VK_SHADER_STAGE_COMPUTE_BIT.
  677. // - supportedOperations has VK_SUBGROUP_FEATURE_QUAD_BIT.
  678. subgroup_capabilities.quad_operations_in_all_stages = subgroup_properties.quadOperationsInAllStages;
  679. if (subgroup_capabilities.size_control_is_supported && (subgroup_size_control_properties.requiredSubgroupSizeStages & VK_SHADER_STAGE_COMPUTE_BIT)) {
  680. subgroup_capabilities.min_size = subgroup_size_control_properties.minSubgroupSize;
  681. subgroup_capabilities.max_size = subgroup_size_control_properties.maxSubgroupSize;
  682. }
  683. if (vrs_capabilities.pipeline_vrs_supported || vrs_capabilities.primitive_vrs_supported || vrs_capabilities.attachment_vrs_supported) {
  684. print_verbose("- Vulkan Variable Rate Shading supported:");
  685. if (vrs_capabilities.pipeline_vrs_supported) {
  686. print_verbose(" Pipeline fragment shading rate");
  687. }
  688. if (vrs_capabilities.primitive_vrs_supported) {
  689. print_verbose(" Primitive fragment shading rate");
  690. }
  691. if (vrs_capabilities.attachment_vrs_supported) {
  692. // TODO: Expose these somehow to the end user.
  693. vrs_capabilities.min_texel_size.x = vrs_properties.minFragmentShadingRateAttachmentTexelSize.width;
  694. vrs_capabilities.min_texel_size.y = vrs_properties.minFragmentShadingRateAttachmentTexelSize.height;
  695. vrs_capabilities.max_texel_size.x = vrs_properties.maxFragmentShadingRateAttachmentTexelSize.width;
  696. vrs_capabilities.max_texel_size.y = vrs_properties.maxFragmentShadingRateAttachmentTexelSize.height;
  697. // We'll attempt to default to a texel size of 16x16.
  698. vrs_capabilities.texel_size.x = CLAMP(16, vrs_capabilities.min_texel_size.x, vrs_capabilities.max_texel_size.x);
  699. vrs_capabilities.texel_size.y = CLAMP(16, vrs_capabilities.min_texel_size.y, vrs_capabilities.max_texel_size.y);
  700. print_verbose(String(" Attachment fragment shading rate") + String(", min texel size: (") + itos(vrs_capabilities.min_texel_size.x) + String(", ") + itos(vrs_capabilities.min_texel_size.y) + String(")") + String(", max texel size: (") + itos(vrs_capabilities.max_texel_size.x) + String(", ") + itos(vrs_capabilities.max_texel_size.y) + String(")"));
  701. }
  702. } else {
  703. print_verbose("- Vulkan Variable Rate Shading not supported");
  704. }
  705. if (multiview_capabilities.is_supported) {
  706. multiview_capabilities.max_view_count = multiview_properties.maxMultiviewViewCount;
  707. multiview_capabilities.max_instance_count = multiview_properties.maxMultiviewInstanceIndex;
  708. print_verbose("- Vulkan multiview supported:");
  709. print_verbose(" max view count: " + itos(multiview_capabilities.max_view_count));
  710. print_verbose(" max instances: " + itos(multiview_capabilities.max_instance_count));
  711. } else {
  712. print_verbose("- Vulkan multiview not supported");
  713. }
  714. print_verbose("- Vulkan subgroup:");
  715. print_verbose(" size: " + itos(subgroup_capabilities.size));
  716. print_verbose(" min size: " + itos(subgroup_capabilities.min_size));
  717. print_verbose(" max size: " + itos(subgroup_capabilities.max_size));
  718. print_verbose(" stages: " + subgroup_capabilities.supported_stages_desc());
  719. print_verbose(" supported ops: " + subgroup_capabilities.supported_operations_desc());
  720. if (subgroup_capabilities.quad_operations_in_all_stages) {
  721. print_verbose(" quad operations in all stages");
  722. }
  723. }
  724. return OK;
  725. }
  726. Error RenderingDeviceDriverVulkan::_add_queue_create_info(LocalVector<VkDeviceQueueCreateInfo> &r_queue_create_info) {
  727. uint32_t queue_family_count = queue_family_properties.size();
  728. queue_families.resize(queue_family_count);
  729. VkQueueFlags queue_flags_mask = VK_QUEUE_GRAPHICS_BIT | VK_QUEUE_COMPUTE_BIT | VK_QUEUE_TRANSFER_BIT;
  730. const uint32_t max_queue_count_per_family = 1;
  731. static const float queue_priorities[max_queue_count_per_family] = {};
  732. for (uint32_t i = 0; i < queue_family_count; i++) {
  733. if ((queue_family_properties[i].queueFlags & queue_flags_mask) == 0) {
  734. // We ignore creating queues in families that don't support any of the operations we require.
  735. continue;
  736. }
  737. VkDeviceQueueCreateInfo create_info = {};
  738. create_info.sType = VK_STRUCTURE_TYPE_DEVICE_QUEUE_CREATE_INFO;
  739. create_info.queueFamilyIndex = i;
  740. create_info.queueCount = MIN(queue_family_properties[i].queueCount, max_queue_count_per_family);
  741. create_info.pQueuePriorities = queue_priorities;
  742. r_queue_create_info.push_back(create_info);
  743. // Prepare the vectors where the queues will be filled out.
  744. queue_families[i].resize(create_info.queueCount);
  745. }
  746. return OK;
  747. }
  748. Error RenderingDeviceDriverVulkan::_initialize_device(const LocalVector<VkDeviceQueueCreateInfo> &p_queue_create_info) {
  749. TightLocalVector<const char *> enabled_extension_names;
  750. enabled_extension_names.reserve(enabled_device_extension_names.size());
  751. for (const CharString &extension_name : enabled_device_extension_names) {
  752. enabled_extension_names.push_back(extension_name.ptr());
  753. }
  754. void *create_info_next = nullptr;
  755. VkPhysicalDeviceShaderFloat16Int8FeaturesKHR shader_features = {};
  756. shader_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_SHADER_FLOAT16_INT8_FEATURES_KHR;
  757. shader_features.pNext = create_info_next;
  758. shader_features.shaderFloat16 = shader_capabilities.shader_float16_is_supported;
  759. shader_features.shaderInt8 = shader_capabilities.shader_int8_is_supported;
  760. create_info_next = &shader_features;
  761. VkPhysicalDeviceFragmentShadingRateFeaturesKHR vrs_features = {};
  762. if (vrs_capabilities.pipeline_vrs_supported || vrs_capabilities.primitive_vrs_supported || vrs_capabilities.attachment_vrs_supported) {
  763. vrs_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_FRAGMENT_SHADING_RATE_FEATURES_KHR;
  764. vrs_features.pNext = create_info_next;
  765. vrs_features.pipelineFragmentShadingRate = vrs_capabilities.pipeline_vrs_supported;
  766. vrs_features.primitiveFragmentShadingRate = vrs_capabilities.primitive_vrs_supported;
  767. vrs_features.attachmentFragmentShadingRate = vrs_capabilities.attachment_vrs_supported;
  768. create_info_next = &vrs_features;
  769. }
  770. VkPhysicalDevicePipelineCreationCacheControlFeatures pipeline_cache_control_features = {};
  771. if (pipeline_cache_control_support) {
  772. pipeline_cache_control_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_PIPELINE_CREATION_CACHE_CONTROL_FEATURES;
  773. pipeline_cache_control_features.pNext = create_info_next;
  774. pipeline_cache_control_features.pipelineCreationCacheControl = pipeline_cache_control_support;
  775. create_info_next = &pipeline_cache_control_features;
  776. }
  777. VkPhysicalDeviceVulkan11Features vulkan_1_1_features = {};
  778. VkPhysicalDevice16BitStorageFeaturesKHR storage_features = {};
  779. VkPhysicalDeviceMultiviewFeatures multiview_features = {};
  780. const bool enable_1_2_features = physical_device_properties.apiVersion >= VK_API_VERSION_1_2;
  781. if (enable_1_2_features) {
  782. // In Vulkan 1.2 and newer we use a newer struct to enable various features.
  783. vulkan_1_1_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_VULKAN_1_1_FEATURES;
  784. vulkan_1_1_features.pNext = create_info_next;
  785. vulkan_1_1_features.storageBuffer16BitAccess = storage_buffer_capabilities.storage_buffer_16_bit_access_is_supported;
  786. vulkan_1_1_features.uniformAndStorageBuffer16BitAccess = storage_buffer_capabilities.uniform_and_storage_buffer_16_bit_access_is_supported;
  787. vulkan_1_1_features.storagePushConstant16 = storage_buffer_capabilities.storage_push_constant_16_is_supported;
  788. vulkan_1_1_features.storageInputOutput16 = storage_buffer_capabilities.storage_input_output_16;
  789. vulkan_1_1_features.multiview = multiview_capabilities.is_supported;
  790. vulkan_1_1_features.multiviewGeometryShader = multiview_capabilities.geometry_shader_is_supported;
  791. vulkan_1_1_features.multiviewTessellationShader = multiview_capabilities.tessellation_shader_is_supported;
  792. vulkan_1_1_features.variablePointersStorageBuffer = 0;
  793. vulkan_1_1_features.variablePointers = 0;
  794. vulkan_1_1_features.protectedMemory = 0;
  795. vulkan_1_1_features.samplerYcbcrConversion = 0;
  796. vulkan_1_1_features.shaderDrawParameters = 0;
  797. create_info_next = &vulkan_1_1_features;
  798. } else {
  799. // On Vulkan 1.0 and 1.1 we use our older structs to initialize these features.
  800. storage_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_16BIT_STORAGE_FEATURES_KHR;
  801. storage_features.pNext = create_info_next;
  802. storage_features.storageBuffer16BitAccess = storage_buffer_capabilities.storage_buffer_16_bit_access_is_supported;
  803. storage_features.uniformAndStorageBuffer16BitAccess = storage_buffer_capabilities.uniform_and_storage_buffer_16_bit_access_is_supported;
  804. storage_features.storagePushConstant16 = storage_buffer_capabilities.storage_push_constant_16_is_supported;
  805. storage_features.storageInputOutput16 = storage_buffer_capabilities.storage_input_output_16;
  806. create_info_next = &storage_features;
  807. const bool enable_1_1_features = physical_device_properties.apiVersion >= VK_API_VERSION_1_1;
  808. if (enable_1_1_features) {
  809. multiview_features.sType = VK_STRUCTURE_TYPE_PHYSICAL_DEVICE_MULTIVIEW_FEATURES;
  810. multiview_features.pNext = create_info_next;
  811. multiview_features.multiview = multiview_capabilities.is_supported;
  812. multiview_features.multiviewGeometryShader = multiview_capabilities.geometry_shader_is_supported;
  813. multiview_features.multiviewTessellationShader = multiview_capabilities.tessellation_shader_is_supported;
  814. create_info_next = &multiview_features;
  815. }
  816. }
  817. VkDeviceCreateInfo create_info = {};
  818. create_info.sType = VK_STRUCTURE_TYPE_DEVICE_CREATE_INFO;
  819. create_info.pNext = create_info_next;
  820. create_info.queueCreateInfoCount = p_queue_create_info.size();
  821. create_info.pQueueCreateInfos = p_queue_create_info.ptr();
  822. create_info.enabledExtensionCount = enabled_extension_names.size();
  823. create_info.ppEnabledExtensionNames = enabled_extension_names.ptr();
  824. create_info.pEnabledFeatures = &requested_device_features;
  825. if (VulkanHooks::get_singleton() != nullptr) {
  826. bool device_created = VulkanHooks::get_singleton()->create_vulkan_device(&create_info, &vk_device);
  827. ERR_FAIL_COND_V(!device_created, ERR_CANT_CREATE);
  828. } else {
  829. VkResult err = vkCreateDevice(physical_device, &create_info, nullptr, &vk_device);
  830. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  831. }
  832. for (uint32_t i = 0; i < queue_families.size(); i++) {
  833. for (uint32_t j = 0; j < queue_families[i].size(); j++) {
  834. vkGetDeviceQueue(vk_device, i, j, &queue_families[i][j].queue);
  835. }
  836. }
  837. const RenderingContextDriverVulkan::Functions &functions = context_driver->functions_get();
  838. if (functions.GetDeviceProcAddr != nullptr) {
  839. device_functions.CreateSwapchainKHR = PFN_vkCreateSwapchainKHR(functions.GetDeviceProcAddr(vk_device, "vkCreateSwapchainKHR"));
  840. device_functions.DestroySwapchainKHR = PFN_vkDestroySwapchainKHR(functions.GetDeviceProcAddr(vk_device, "vkDestroySwapchainKHR"));
  841. device_functions.GetSwapchainImagesKHR = PFN_vkGetSwapchainImagesKHR(functions.GetDeviceProcAddr(vk_device, "vkGetSwapchainImagesKHR"));
  842. device_functions.AcquireNextImageKHR = PFN_vkAcquireNextImageKHR(functions.GetDeviceProcAddr(vk_device, "vkAcquireNextImageKHR"));
  843. device_functions.QueuePresentKHR = PFN_vkQueuePresentKHR(functions.GetDeviceProcAddr(vk_device, "vkQueuePresentKHR"));
  844. if (enabled_device_extension_names.has(VK_KHR_CREATE_RENDERPASS_2_EXTENSION_NAME)) {
  845. device_functions.CreateRenderPass2KHR = PFN_vkCreateRenderPass2KHR(functions.GetDeviceProcAddr(vk_device, "vkCreateRenderPass2KHR"));
  846. }
  847. }
  848. return OK;
  849. }
  850. Error RenderingDeviceDriverVulkan::_initialize_allocator() {
  851. VmaAllocatorCreateInfo allocator_info = {};
  852. allocator_info.physicalDevice = physical_device;
  853. allocator_info.device = vk_device;
  854. allocator_info.instance = context_driver->instance_get();
  855. VkResult err = vmaCreateAllocator(&allocator_info, &allocator);
  856. ERR_FAIL_COND_V_MSG(err, ERR_CANT_CREATE, "vmaCreateAllocator failed with error " + itos(err) + ".");
  857. return OK;
  858. }
  859. Error RenderingDeviceDriverVulkan::_initialize_pipeline_cache() {
  860. pipelines_cache.buffer.resize(sizeof(PipelineCacheHeader));
  861. PipelineCacheHeader *header = (PipelineCacheHeader *)(pipelines_cache.buffer.ptrw());
  862. *header = {};
  863. header->magic = 868 + VK_PIPELINE_CACHE_HEADER_VERSION_ONE;
  864. header->device_id = physical_device_properties.deviceID;
  865. header->vendor_id = physical_device_properties.vendorID;
  866. header->driver_version = physical_device_properties.driverVersion;
  867. memcpy(header->uuid, physical_device_properties.pipelineCacheUUID, VK_UUID_SIZE);
  868. header->driver_abi = sizeof(void *);
  869. pipeline_cache_id = String::hex_encode_buffer(physical_device_properties.pipelineCacheUUID, VK_UUID_SIZE);
  870. pipeline_cache_id += "-driver-" + itos(physical_device_properties.driverVersion);
  871. return OK;
  872. }
  873. static void _convert_subpass_attachments(const VkAttachmentReference2 *p_attachment_references_2, uint32_t p_attachment_references_count, TightLocalVector<VkAttachmentReference> &r_attachment_references) {
  874. r_attachment_references.resize(p_attachment_references_count);
  875. for (uint32_t i = 0; i < p_attachment_references_count; i++) {
  876. // Ignore sType, pNext and aspectMask (which is currently unused).
  877. r_attachment_references[i].attachment = p_attachment_references_2[i].attachment;
  878. r_attachment_references[i].layout = p_attachment_references_2[i].layout;
  879. }
  880. }
  881. VkResult RenderingDeviceDriverVulkan::_create_render_pass(VkDevice p_device, const VkRenderPassCreateInfo2 *p_create_info, const VkAllocationCallbacks *p_allocator, VkRenderPass *p_render_pass) {
  882. if (device_functions.CreateRenderPass2KHR != nullptr) {
  883. return device_functions.CreateRenderPass2KHR(p_device, p_create_info, p_allocator, p_render_pass);
  884. } else {
  885. // Compatibility fallback with regular create render pass but by converting the inputs from the newer version to the older one.
  886. TightLocalVector<VkAttachmentDescription> attachments;
  887. attachments.resize(p_create_info->attachmentCount);
  888. for (uint32_t i = 0; i < p_create_info->attachmentCount; i++) {
  889. // Ignores sType and pNext from the attachment.
  890. const VkAttachmentDescription2 &src = p_create_info->pAttachments[i];
  891. VkAttachmentDescription &dst = attachments[i];
  892. dst.flags = src.flags;
  893. dst.format = src.format;
  894. dst.samples = src.samples;
  895. dst.loadOp = src.loadOp;
  896. dst.storeOp = src.storeOp;
  897. dst.stencilLoadOp = src.stencilLoadOp;
  898. dst.stencilStoreOp = src.stencilStoreOp;
  899. dst.initialLayout = src.initialLayout;
  900. dst.finalLayout = src.finalLayout;
  901. }
  902. const uint32_t attachment_vectors_per_subpass = 4;
  903. TightLocalVector<TightLocalVector<VkAttachmentReference>> subpasses_attachments;
  904. TightLocalVector<VkSubpassDescription> subpasses;
  905. subpasses_attachments.resize(p_create_info->subpassCount * attachment_vectors_per_subpass);
  906. subpasses.resize(p_create_info->subpassCount);
  907. for (uint32_t i = 0; i < p_create_info->subpassCount; i++) {
  908. const uint32_t vector_base_index = i * attachment_vectors_per_subpass;
  909. const uint32_t input_attachments_index = vector_base_index + 0;
  910. const uint32_t color_attachments_index = vector_base_index + 1;
  911. const uint32_t resolve_attachments_index = vector_base_index + 2;
  912. const uint32_t depth_attachment_index = vector_base_index + 3;
  913. _convert_subpass_attachments(p_create_info->pSubpasses[i].pInputAttachments, p_create_info->pSubpasses[i].inputAttachmentCount, subpasses_attachments[input_attachments_index]);
  914. _convert_subpass_attachments(p_create_info->pSubpasses[i].pColorAttachments, p_create_info->pSubpasses[i].colorAttachmentCount, subpasses_attachments[color_attachments_index]);
  915. _convert_subpass_attachments(p_create_info->pSubpasses[i].pResolveAttachments, p_create_info->pSubpasses[i].colorAttachmentCount, subpasses_attachments[resolve_attachments_index]);
  916. _convert_subpass_attachments(p_create_info->pSubpasses[i].pDepthStencilAttachment, (p_create_info->pSubpasses[i].pDepthStencilAttachment != nullptr) ? 1 : 0, subpasses_attachments[depth_attachment_index]);
  917. // Ignores sType and pNext from the subpass.
  918. const VkSubpassDescription2 &src_subpass = p_create_info->pSubpasses[i];
  919. VkSubpassDescription &dst_subpass = subpasses[i];
  920. dst_subpass.flags = src_subpass.flags;
  921. dst_subpass.pipelineBindPoint = src_subpass.pipelineBindPoint;
  922. dst_subpass.inputAttachmentCount = src_subpass.inputAttachmentCount;
  923. dst_subpass.pInputAttachments = subpasses_attachments[input_attachments_index].ptr();
  924. dst_subpass.colorAttachmentCount = src_subpass.colorAttachmentCount;
  925. dst_subpass.pColorAttachments = subpasses_attachments[color_attachments_index].ptr();
  926. dst_subpass.pResolveAttachments = subpasses_attachments[resolve_attachments_index].ptr();
  927. dst_subpass.pDepthStencilAttachment = subpasses_attachments[depth_attachment_index].ptr();
  928. dst_subpass.preserveAttachmentCount = src_subpass.preserveAttachmentCount;
  929. dst_subpass.pPreserveAttachments = src_subpass.pPreserveAttachments;
  930. }
  931. TightLocalVector<VkSubpassDependency> dependencies;
  932. dependencies.resize(p_create_info->dependencyCount);
  933. for (uint32_t i = 0; i < p_create_info->dependencyCount; i++) {
  934. // Ignores sType and pNext from the dependency, and viewMask which is currently unused.
  935. const VkSubpassDependency2 &src_dependency = p_create_info->pDependencies[i];
  936. VkSubpassDependency &dst_dependency = dependencies[i];
  937. dst_dependency.srcSubpass = src_dependency.srcSubpass;
  938. dst_dependency.dstSubpass = src_dependency.dstSubpass;
  939. dst_dependency.srcStageMask = src_dependency.srcStageMask;
  940. dst_dependency.dstStageMask = src_dependency.dstStageMask;
  941. dst_dependency.srcAccessMask = src_dependency.srcAccessMask;
  942. dst_dependency.dstAccessMask = src_dependency.dstAccessMask;
  943. dst_dependency.dependencyFlags = src_dependency.dependencyFlags;
  944. }
  945. VkRenderPassCreateInfo create_info = {};
  946. create_info.sType = VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO;
  947. create_info.pNext = p_create_info->pNext;
  948. create_info.flags = p_create_info->flags;
  949. create_info.attachmentCount = attachments.size();
  950. create_info.pAttachments = attachments.ptr();
  951. create_info.subpassCount = subpasses.size();
  952. create_info.pSubpasses = subpasses.ptr();
  953. create_info.dependencyCount = dependencies.size();
  954. create_info.pDependencies = dependencies.ptr();
  955. return vkCreateRenderPass(vk_device, &create_info, p_allocator, p_render_pass);
  956. }
  957. }
  958. bool RenderingDeviceDriverVulkan::_release_image_semaphore(CommandQueue *p_command_queue, uint32_t p_semaphore_index, bool p_release_on_swap_chain) {
  959. SwapChain *swap_chain = p_command_queue->image_semaphores_swap_chains[p_semaphore_index];
  960. if (swap_chain != nullptr) {
  961. // Clear the swap chain from the command queue's vector.
  962. p_command_queue->image_semaphores_swap_chains[p_semaphore_index] = nullptr;
  963. if (p_release_on_swap_chain) {
  964. // Remove the acquired semaphore from the swap chain's vectors.
  965. for (uint32_t i = 0; i < swap_chain->command_queues_acquired.size(); i++) {
  966. if (swap_chain->command_queues_acquired[i] == p_command_queue && swap_chain->command_queues_acquired_semaphores[i] == p_semaphore_index) {
  967. swap_chain->command_queues_acquired.remove_at(i);
  968. swap_chain->command_queues_acquired_semaphores.remove_at(i);
  969. break;
  970. }
  971. }
  972. }
  973. return true;
  974. }
  975. return false;
  976. }
  977. bool RenderingDeviceDriverVulkan::_recreate_image_semaphore(CommandQueue *p_command_queue, uint32_t p_semaphore_index, bool p_release_on_swap_chain) {
  978. _release_image_semaphore(p_command_queue, p_semaphore_index, p_release_on_swap_chain);
  979. VkSemaphore semaphore;
  980. VkSemaphoreCreateInfo create_info = {};
  981. create_info.sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO;
  982. VkResult err = vkCreateSemaphore(vk_device, &create_info, nullptr, &semaphore);
  983. ERR_FAIL_COND_V(err != VK_SUCCESS, false);
  984. // Indicate the semaphore is free again and destroy the previous one before storing the new one.
  985. vkDestroySemaphore(vk_device, p_command_queue->image_semaphores[p_semaphore_index], nullptr);
  986. p_command_queue->image_semaphores[p_semaphore_index] = semaphore;
  987. p_command_queue->free_image_semaphores.push_back(p_semaphore_index);
  988. return true;
  989. }
  990. void RenderingDeviceDriverVulkan::_set_object_name(VkObjectType p_object_type, uint64_t p_object_handle, String p_object_name) {
  991. const RenderingContextDriverVulkan::Functions &functions = context_driver->functions_get();
  992. if (functions.SetDebugUtilsObjectNameEXT != nullptr) {
  993. CharString obj_data = p_object_name.utf8();
  994. VkDebugUtilsObjectNameInfoEXT name_info;
  995. name_info.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_OBJECT_NAME_INFO_EXT;
  996. name_info.pNext = nullptr;
  997. name_info.objectType = p_object_type;
  998. name_info.objectHandle = p_object_handle;
  999. name_info.pObjectName = obj_data.get_data();
  1000. functions.SetDebugUtilsObjectNameEXT(vk_device, &name_info);
  1001. }
  1002. }
  1003. Error RenderingDeviceDriverVulkan::initialize(uint32_t p_device_index, uint32_t p_frame_count) {
  1004. context_device = context_driver->device_get(p_device_index);
  1005. physical_device = context_driver->physical_device_get(p_device_index);
  1006. vkGetPhysicalDeviceProperties(physical_device, &physical_device_properties);
  1007. frame_count = p_frame_count;
  1008. // Copy the queue family properties the context already retrieved.
  1009. uint32_t queue_family_count = context_driver->queue_family_get_count(p_device_index);
  1010. queue_family_properties.resize(queue_family_count);
  1011. for (uint32_t i = 0; i < queue_family_count; i++) {
  1012. queue_family_properties[i] = context_driver->queue_family_get(p_device_index, i);
  1013. }
  1014. Error err = _initialize_device_extensions();
  1015. ERR_FAIL_COND_V(err != OK, err);
  1016. err = _check_device_features();
  1017. ERR_FAIL_COND_V(err != OK, err);
  1018. err = _check_device_capabilities();
  1019. ERR_FAIL_COND_V(err != OK, err);
  1020. LocalVector<VkDeviceQueueCreateInfo> queue_create_info;
  1021. err = _add_queue_create_info(queue_create_info);
  1022. ERR_FAIL_COND_V(err != OK, err);
  1023. err = _initialize_device(queue_create_info);
  1024. ERR_FAIL_COND_V(err != OK, err);
  1025. err = _initialize_allocator();
  1026. ERR_FAIL_COND_V(err != OK, err);
  1027. err = _initialize_pipeline_cache();
  1028. ERR_FAIL_COND_V(err != OK, err);
  1029. max_descriptor_sets_per_pool = GLOBAL_GET("rendering/rendering_device/vulkan/max_descriptors_per_pool");
  1030. return OK;
  1031. }
  1032. /****************/
  1033. /**** MEMORY ****/
  1034. /****************/
  1035. static const uint32_t SMALL_ALLOCATION_MAX_SIZE = 4096;
  1036. VmaPool RenderingDeviceDriverVulkan::_find_or_create_small_allocs_pool(uint32_t p_mem_type_index) {
  1037. if (small_allocs_pools.has(p_mem_type_index)) {
  1038. return small_allocs_pools[p_mem_type_index];
  1039. }
  1040. print_verbose("Creating VMA small objects pool for memory type index " + itos(p_mem_type_index));
  1041. VmaPoolCreateInfo pci = {};
  1042. pci.memoryTypeIndex = p_mem_type_index;
  1043. pci.flags = 0;
  1044. pci.blockSize = 0;
  1045. pci.minBlockCount = 0;
  1046. pci.maxBlockCount = SIZE_MAX;
  1047. pci.priority = 0.5f;
  1048. pci.minAllocationAlignment = 0;
  1049. pci.pMemoryAllocateNext = nullptr;
  1050. VmaPool pool = VK_NULL_HANDLE;
  1051. VkResult res = vmaCreatePool(allocator, &pci, &pool);
  1052. small_allocs_pools[p_mem_type_index] = pool; // Don't try to create it again if failed the first time.
  1053. ERR_FAIL_COND_V_MSG(res, pool, "vmaCreatePool failed with error " + itos(res) + ".");
  1054. return pool;
  1055. }
  1056. /*****************/
  1057. /**** BUFFERS ****/
  1058. /*****************/
  1059. // RDD::BufferUsageBits == VkBufferUsageFlagBits.
  1060. static_assert(ENUM_MEMBERS_EQUAL(RDD::BUFFER_USAGE_TRANSFER_FROM_BIT, VK_BUFFER_USAGE_TRANSFER_SRC_BIT));
  1061. static_assert(ENUM_MEMBERS_EQUAL(RDD::BUFFER_USAGE_TRANSFER_TO_BIT, VK_BUFFER_USAGE_TRANSFER_DST_BIT));
  1062. static_assert(ENUM_MEMBERS_EQUAL(RDD::BUFFER_USAGE_TEXEL_BIT, VK_BUFFER_USAGE_UNIFORM_TEXEL_BUFFER_BIT));
  1063. static_assert(ENUM_MEMBERS_EQUAL(RDD::BUFFER_USAGE_UNIFORM_BIT, VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT));
  1064. static_assert(ENUM_MEMBERS_EQUAL(RDD::BUFFER_USAGE_STORAGE_BIT, VK_BUFFER_USAGE_STORAGE_BUFFER_BIT));
  1065. static_assert(ENUM_MEMBERS_EQUAL(RDD::BUFFER_USAGE_INDEX_BIT, VK_BUFFER_USAGE_INDEX_BUFFER_BIT));
  1066. static_assert(ENUM_MEMBERS_EQUAL(RDD::BUFFER_USAGE_VERTEX_BIT, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT));
  1067. static_assert(ENUM_MEMBERS_EQUAL(RDD::BUFFER_USAGE_INDIRECT_BIT, VK_BUFFER_USAGE_INDIRECT_BUFFER_BIT));
  1068. RDD::BufferID RenderingDeviceDriverVulkan::buffer_create(uint64_t p_size, BitField<BufferUsageBits> p_usage, MemoryAllocationType p_allocation_type) {
  1069. VkBufferCreateInfo create_info = {};
  1070. create_info.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
  1071. create_info.size = p_size;
  1072. create_info.usage = p_usage;
  1073. create_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  1074. VmaAllocationCreateInfo alloc_create_info = {};
  1075. switch (p_allocation_type) {
  1076. case MEMORY_ALLOCATION_TYPE_CPU: {
  1077. bool is_src = p_usage.has_flag(BUFFER_USAGE_TRANSFER_FROM_BIT);
  1078. bool is_dst = p_usage.has_flag(BUFFER_USAGE_TRANSFER_TO_BIT);
  1079. if (is_src && !is_dst) {
  1080. // Looks like a staging buffer: CPU maps, writes sequentially, then GPU copies to VRAM.
  1081. alloc_create_info.flags = VMA_ALLOCATION_CREATE_HOST_ACCESS_SEQUENTIAL_WRITE_BIT;
  1082. }
  1083. if (is_dst && !is_src) {
  1084. // Looks like a readback buffer: GPU copies from VRAM, then CPU maps and reads.
  1085. alloc_create_info.flags = VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT;
  1086. }
  1087. alloc_create_info.usage = VMA_MEMORY_USAGE_AUTO_PREFER_HOST;
  1088. alloc_create_info.requiredFlags = (VK_MEMORY_PROPERTY_HOST_COHERENT_BIT | VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT);
  1089. } break;
  1090. case MEMORY_ALLOCATION_TYPE_GPU: {
  1091. alloc_create_info.usage = VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE;
  1092. if (p_size <= SMALL_ALLOCATION_MAX_SIZE) {
  1093. uint32_t mem_type_index = 0;
  1094. vmaFindMemoryTypeIndexForBufferInfo(allocator, &create_info, &alloc_create_info, &mem_type_index);
  1095. alloc_create_info.pool = _find_or_create_small_allocs_pool(mem_type_index);
  1096. }
  1097. } break;
  1098. }
  1099. VkBuffer vk_buffer = VK_NULL_HANDLE;
  1100. VmaAllocation allocation = nullptr;
  1101. VmaAllocationInfo alloc_info = {};
  1102. VkResult err = vmaCreateBuffer(allocator, &create_info, &alloc_create_info, &vk_buffer, &allocation, &alloc_info);
  1103. ERR_FAIL_COND_V_MSG(err, BufferID(), "Can't create buffer of size: " + itos(p_size) + ", error " + itos(err) + ".");
  1104. // Bookkeep.
  1105. BufferInfo *buf_info = VersatileResource::allocate<BufferInfo>(resources_allocator);
  1106. buf_info->vk_buffer = vk_buffer;
  1107. buf_info->allocation.handle = allocation;
  1108. buf_info->allocation.size = alloc_info.size;
  1109. buf_info->size = p_size;
  1110. return BufferID(buf_info);
  1111. }
  1112. bool RenderingDeviceDriverVulkan::buffer_set_texel_format(BufferID p_buffer, DataFormat p_format) {
  1113. BufferInfo *buf_info = (BufferInfo *)p_buffer.id;
  1114. DEV_ASSERT(!buf_info->vk_view);
  1115. VkBufferViewCreateInfo view_create_info = {};
  1116. view_create_info.sType = VK_STRUCTURE_TYPE_BUFFER_VIEW_CREATE_INFO;
  1117. view_create_info.buffer = buf_info->vk_buffer;
  1118. view_create_info.format = RD_TO_VK_FORMAT[p_format];
  1119. view_create_info.range = buf_info->allocation.size;
  1120. VkResult res = vkCreateBufferView(vk_device, &view_create_info, nullptr, &buf_info->vk_view);
  1121. ERR_FAIL_COND_V_MSG(res, false, "Unable to create buffer view, error " + itos(res) + ".");
  1122. return true;
  1123. }
  1124. void RenderingDeviceDriverVulkan::buffer_free(BufferID p_buffer) {
  1125. BufferInfo *buf_info = (BufferInfo *)p_buffer.id;
  1126. if (buf_info->vk_view) {
  1127. vkDestroyBufferView(vk_device, buf_info->vk_view, nullptr);
  1128. }
  1129. vmaDestroyBuffer(allocator, buf_info->vk_buffer, buf_info->allocation.handle);
  1130. VersatileResource::free(resources_allocator, buf_info);
  1131. }
  1132. uint64_t RenderingDeviceDriverVulkan::buffer_get_allocation_size(BufferID p_buffer) {
  1133. const BufferInfo *buf_info = (const BufferInfo *)p_buffer.id;
  1134. return buf_info->allocation.size;
  1135. }
  1136. uint8_t *RenderingDeviceDriverVulkan::buffer_map(BufferID p_buffer) {
  1137. const BufferInfo *buf_info = (const BufferInfo *)p_buffer.id;
  1138. void *data_ptr = nullptr;
  1139. VkResult err = vmaMapMemory(allocator, buf_info->allocation.handle, &data_ptr);
  1140. ERR_FAIL_COND_V_MSG(err, nullptr, "vmaMapMemory failed with error " + itos(err) + ".");
  1141. return (uint8_t *)data_ptr;
  1142. }
  1143. void RenderingDeviceDriverVulkan::buffer_unmap(BufferID p_buffer) {
  1144. const BufferInfo *buf_info = (const BufferInfo *)p_buffer.id;
  1145. vmaUnmapMemory(allocator, buf_info->allocation.handle);
  1146. }
  1147. /*****************/
  1148. /**** TEXTURE ****/
  1149. /*****************/
  1150. static const VkImageType RD_TEX_TYPE_TO_VK_IMG_TYPE[RDD::TEXTURE_TYPE_MAX] = {
  1151. VK_IMAGE_TYPE_1D,
  1152. VK_IMAGE_TYPE_2D,
  1153. VK_IMAGE_TYPE_3D,
  1154. VK_IMAGE_TYPE_2D,
  1155. VK_IMAGE_TYPE_1D,
  1156. VK_IMAGE_TYPE_2D,
  1157. VK_IMAGE_TYPE_2D,
  1158. };
  1159. static const VkSampleCountFlagBits RD_TO_VK_SAMPLE_COUNT[RDD::TEXTURE_SAMPLES_MAX] = {
  1160. VK_SAMPLE_COUNT_1_BIT,
  1161. VK_SAMPLE_COUNT_2_BIT,
  1162. VK_SAMPLE_COUNT_4_BIT,
  1163. VK_SAMPLE_COUNT_8_BIT,
  1164. VK_SAMPLE_COUNT_16_BIT,
  1165. VK_SAMPLE_COUNT_32_BIT,
  1166. VK_SAMPLE_COUNT_64_BIT,
  1167. };
  1168. // RDD::TextureType == VkImageViewType.
  1169. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_TYPE_1D, VK_IMAGE_VIEW_TYPE_1D));
  1170. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_TYPE_2D, VK_IMAGE_VIEW_TYPE_2D));
  1171. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_TYPE_3D, VK_IMAGE_VIEW_TYPE_3D));
  1172. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_TYPE_CUBE, VK_IMAGE_VIEW_TYPE_CUBE));
  1173. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_TYPE_1D_ARRAY, VK_IMAGE_VIEW_TYPE_1D_ARRAY));
  1174. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_TYPE_2D_ARRAY, VK_IMAGE_VIEW_TYPE_2D_ARRAY));
  1175. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_TYPE_CUBE_ARRAY, VK_IMAGE_VIEW_TYPE_CUBE_ARRAY));
  1176. // RDD::TextureSwizzle == VkComponentSwizzle.
  1177. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_SWIZZLE_IDENTITY, VK_COMPONENT_SWIZZLE_IDENTITY));
  1178. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_SWIZZLE_ZERO, VK_COMPONENT_SWIZZLE_ZERO));
  1179. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_SWIZZLE_ONE, VK_COMPONENT_SWIZZLE_ONE));
  1180. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_SWIZZLE_R, VK_COMPONENT_SWIZZLE_R));
  1181. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_SWIZZLE_G, VK_COMPONENT_SWIZZLE_G));
  1182. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_SWIZZLE_B, VK_COMPONENT_SWIZZLE_B));
  1183. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_SWIZZLE_A, VK_COMPONENT_SWIZZLE_A));
  1184. // RDD::TextureLayout == VkImageLayout.
  1185. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_UNDEFINED, VK_IMAGE_LAYOUT_UNDEFINED));
  1186. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_GENERAL, VK_IMAGE_LAYOUT_GENERAL));
  1187. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL));
  1188. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_DEPTH_STENCIL_ATTACHMENT_OPTIMAL));
  1189. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL, VK_IMAGE_LAYOUT_DEPTH_STENCIL_READ_ONLY_OPTIMAL));
  1190. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_SHADER_READ_ONLY_OPTIMAL, VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL));
  1191. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_TRANSFER_SRC_OPTIMAL, VK_IMAGE_LAYOUT_TRANSFER_SRC_OPTIMAL));
  1192. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_TRANSFER_DST_OPTIMAL, VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL));
  1193. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_PREINITIALIZED, VK_IMAGE_LAYOUT_PREINITIALIZED));
  1194. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_LAYOUT_VRS_ATTACHMENT_OPTIMAL, VK_IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR));
  1195. // RDD::TextureAspectBits == VkImageAspectFlagBits.
  1196. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_ASPECT_COLOR_BIT, VK_IMAGE_ASPECT_COLOR_BIT));
  1197. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_ASPECT_DEPTH_BIT, VK_IMAGE_ASPECT_DEPTH_BIT));
  1198. static_assert(ENUM_MEMBERS_EQUAL(RDD::TEXTURE_ASPECT_STENCIL_BIT, VK_IMAGE_ASPECT_STENCIL_BIT));
  1199. VkSampleCountFlagBits RenderingDeviceDriverVulkan::_ensure_supported_sample_count(TextureSamples p_requested_sample_count) {
  1200. VkSampleCountFlags sample_count_flags = (physical_device_properties.limits.framebufferColorSampleCounts & physical_device_properties.limits.framebufferDepthSampleCounts);
  1201. if ((sample_count_flags & RD_TO_VK_SAMPLE_COUNT[p_requested_sample_count])) {
  1202. // The requested sample count is supported.
  1203. return RD_TO_VK_SAMPLE_COUNT[p_requested_sample_count];
  1204. } else {
  1205. // Find the closest lower supported sample count.
  1206. VkSampleCountFlagBits sample_count = RD_TO_VK_SAMPLE_COUNT[p_requested_sample_count];
  1207. while (sample_count > VK_SAMPLE_COUNT_1_BIT) {
  1208. if (sample_count_flags & sample_count) {
  1209. return sample_count;
  1210. }
  1211. sample_count = (VkSampleCountFlagBits)(sample_count >> 1);
  1212. }
  1213. }
  1214. return VK_SAMPLE_COUNT_1_BIT;
  1215. }
  1216. RDD::TextureID RenderingDeviceDriverVulkan::texture_create(const TextureFormat &p_format, const TextureView &p_view) {
  1217. VkImageCreateInfo create_info = {};
  1218. create_info.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
  1219. if (p_format.shareable_formats.size()) {
  1220. create_info.flags |= VK_IMAGE_CREATE_MUTABLE_FORMAT_BIT;
  1221. if (enabled_device_extension_names.has(VK_KHR_IMAGE_FORMAT_LIST_EXTENSION_NAME)) {
  1222. VkFormat *vk_allowed_formats = ALLOCA_ARRAY(VkFormat, p_format.shareable_formats.size());
  1223. for (int i = 0; i < p_format.shareable_formats.size(); i++) {
  1224. vk_allowed_formats[i] = RD_TO_VK_FORMAT[p_format.shareable_formats[i]];
  1225. }
  1226. VkImageFormatListCreateInfoKHR *format_list_create_info = ALLOCA_SINGLE(VkImageFormatListCreateInfoKHR);
  1227. *format_list_create_info = {};
  1228. format_list_create_info->sType = VK_STRUCTURE_TYPE_IMAGE_FORMAT_LIST_CREATE_INFO_KHR;
  1229. format_list_create_info->viewFormatCount = p_format.shareable_formats.size();
  1230. format_list_create_info->pViewFormats = vk_allowed_formats;
  1231. create_info.pNext = format_list_create_info;
  1232. }
  1233. }
  1234. if (p_format.texture_type == TEXTURE_TYPE_CUBE || p_format.texture_type == TEXTURE_TYPE_CUBE_ARRAY) {
  1235. create_info.flags |= VK_IMAGE_CREATE_CUBE_COMPATIBLE_BIT;
  1236. }
  1237. /*if (p_format.texture_type == TEXTURE_TYPE_2D || p_format.texture_type == TEXTURE_TYPE_2D_ARRAY) {
  1238. create_info.flags |= VK_IMAGE_CREATE_2D_ARRAY_COMPATIBLE_BIT;
  1239. }*/
  1240. create_info.imageType = RD_TEX_TYPE_TO_VK_IMG_TYPE[p_format.texture_type];
  1241. create_info.format = RD_TO_VK_FORMAT[p_format.format];
  1242. create_info.extent.width = p_format.width;
  1243. create_info.extent.height = p_format.height;
  1244. create_info.extent.depth = p_format.depth;
  1245. create_info.mipLevels = p_format.mipmaps;
  1246. create_info.arrayLayers = p_format.array_layers;
  1247. create_info.samples = _ensure_supported_sample_count(p_format.samples);
  1248. create_info.tiling = (p_format.usage_bits & TEXTURE_USAGE_CPU_READ_BIT) ? VK_IMAGE_TILING_LINEAR : VK_IMAGE_TILING_OPTIMAL;
  1249. // Usage.
  1250. if ((p_format.usage_bits & TEXTURE_USAGE_SAMPLING_BIT)) {
  1251. create_info.usage |= VK_IMAGE_USAGE_SAMPLED_BIT;
  1252. }
  1253. if ((p_format.usage_bits & TEXTURE_USAGE_STORAGE_BIT)) {
  1254. create_info.usage |= VK_IMAGE_USAGE_STORAGE_BIT;
  1255. }
  1256. if ((p_format.usage_bits & TEXTURE_USAGE_COLOR_ATTACHMENT_BIT)) {
  1257. create_info.usage |= VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
  1258. }
  1259. if ((p_format.usage_bits & TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
  1260. create_info.usage |= VK_IMAGE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT;
  1261. }
  1262. if ((p_format.usage_bits & TEXTURE_USAGE_INPUT_ATTACHMENT_BIT)) {
  1263. create_info.usage |= VK_IMAGE_USAGE_INPUT_ATTACHMENT_BIT;
  1264. }
  1265. if ((p_format.usage_bits & TEXTURE_USAGE_VRS_ATTACHMENT_BIT)) {
  1266. create_info.usage |= VK_IMAGE_USAGE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR;
  1267. }
  1268. if ((p_format.usage_bits & TEXTURE_USAGE_CAN_UPDATE_BIT)) {
  1269. create_info.usage |= VK_IMAGE_USAGE_TRANSFER_DST_BIT;
  1270. }
  1271. if ((p_format.usage_bits & TEXTURE_USAGE_CAN_COPY_FROM_BIT)) {
  1272. create_info.usage |= VK_IMAGE_USAGE_TRANSFER_SRC_BIT;
  1273. }
  1274. if ((p_format.usage_bits & TEXTURE_USAGE_CAN_COPY_TO_BIT)) {
  1275. create_info.usage |= VK_IMAGE_USAGE_TRANSFER_DST_BIT;
  1276. }
  1277. create_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  1278. create_info.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  1279. // Allocate memory.
  1280. uint32_t width = 0, height = 0;
  1281. uint32_t image_size = get_image_format_required_size(p_format.format, p_format.width, p_format.height, p_format.depth, p_format.mipmaps, &width, &height);
  1282. VmaAllocationCreateInfo alloc_create_info = {};
  1283. alloc_create_info.flags = (p_format.usage_bits & TEXTURE_USAGE_CPU_READ_BIT) ? VMA_ALLOCATION_CREATE_HOST_ACCESS_RANDOM_BIT : 0;
  1284. alloc_create_info.usage = VMA_MEMORY_USAGE_AUTO_PREFER_DEVICE;
  1285. if (image_size <= SMALL_ALLOCATION_MAX_SIZE) {
  1286. uint32_t mem_type_index = 0;
  1287. vmaFindMemoryTypeIndexForImageInfo(allocator, &create_info, &alloc_create_info, &mem_type_index);
  1288. alloc_create_info.pool = _find_or_create_small_allocs_pool(mem_type_index);
  1289. }
  1290. // Create.
  1291. VkImage vk_image = VK_NULL_HANDLE;
  1292. VmaAllocation allocation = nullptr;
  1293. VmaAllocationInfo alloc_info = {};
  1294. VkResult err = vmaCreateImage(allocator, &create_info, &alloc_create_info, &vk_image, &allocation, &alloc_info);
  1295. ERR_FAIL_COND_V_MSG(err, TextureID(), "vmaCreateImage failed with error " + itos(err) + ".");
  1296. // Create view.
  1297. VkImageViewCreateInfo image_view_create_info = {};
  1298. image_view_create_info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
  1299. image_view_create_info.image = vk_image;
  1300. image_view_create_info.viewType = (VkImageViewType)p_format.texture_type;
  1301. image_view_create_info.format = RD_TO_VK_FORMAT[p_view.format];
  1302. image_view_create_info.components.r = (VkComponentSwizzle)p_view.swizzle_r;
  1303. image_view_create_info.components.g = (VkComponentSwizzle)p_view.swizzle_g;
  1304. image_view_create_info.components.b = (VkComponentSwizzle)p_view.swizzle_b;
  1305. image_view_create_info.components.a = (VkComponentSwizzle)p_view.swizzle_a;
  1306. image_view_create_info.subresourceRange.levelCount = create_info.mipLevels;
  1307. image_view_create_info.subresourceRange.layerCount = create_info.arrayLayers;
  1308. if ((p_format.usage_bits & TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
  1309. image_view_create_info.subresourceRange.aspectMask = VK_IMAGE_ASPECT_DEPTH_BIT;
  1310. } else {
  1311. image_view_create_info.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  1312. }
  1313. VkImageView vk_image_view = VK_NULL_HANDLE;
  1314. err = vkCreateImageView(vk_device, &image_view_create_info, nullptr, &vk_image_view);
  1315. if (err) {
  1316. vmaDestroyImage(allocator, vk_image, allocation);
  1317. ERR_FAIL_COND_V_MSG(err, TextureID(), "vkCreateImageView failed with error " + itos(err) + ".");
  1318. }
  1319. // Bookkeep.
  1320. TextureInfo *tex_info = VersatileResource::allocate<TextureInfo>(resources_allocator);
  1321. tex_info->vk_view = vk_image_view;
  1322. tex_info->rd_format = p_format.format;
  1323. tex_info->vk_create_info = create_info;
  1324. tex_info->vk_view_create_info = image_view_create_info;
  1325. tex_info->allocation.handle = allocation;
  1326. vmaGetAllocationInfo(allocator, tex_info->allocation.handle, &tex_info->allocation.info);
  1327. #if PRINT_NATIVE_COMMANDS
  1328. print_line(vformat("vkCreateImageView: 0x%uX for 0x%uX", uint64_t(vk_image_view), uint64_t(vk_image)));
  1329. #endif
  1330. return TextureID(tex_info);
  1331. }
  1332. RDD::TextureID RenderingDeviceDriverVulkan::texture_create_from_extension(uint64_t p_native_texture, TextureType p_type, DataFormat p_format, uint32_t p_array_layers, bool p_depth_stencil) {
  1333. VkImage vk_image = (VkImage)p_native_texture;
  1334. // We only need to create a view into the already existing natively-provided texture.
  1335. VkImageViewCreateInfo image_view_create_info = {};
  1336. image_view_create_info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
  1337. image_view_create_info.image = vk_image;
  1338. image_view_create_info.viewType = (VkImageViewType)p_type;
  1339. image_view_create_info.format = RD_TO_VK_FORMAT[p_format];
  1340. image_view_create_info.components.r = VK_COMPONENT_SWIZZLE_R;
  1341. image_view_create_info.components.g = VK_COMPONENT_SWIZZLE_G;
  1342. image_view_create_info.components.b = VK_COMPONENT_SWIZZLE_B;
  1343. image_view_create_info.components.a = VK_COMPONENT_SWIZZLE_A;
  1344. image_view_create_info.subresourceRange.levelCount = 1;
  1345. image_view_create_info.subresourceRange.layerCount = p_array_layers;
  1346. image_view_create_info.subresourceRange.aspectMask = p_depth_stencil ? VK_IMAGE_ASPECT_DEPTH_BIT : VK_IMAGE_ASPECT_COLOR_BIT;
  1347. VkImageView vk_image_view = VK_NULL_HANDLE;
  1348. VkResult err = vkCreateImageView(vk_device, &image_view_create_info, nullptr, &vk_image_view);
  1349. if (err) {
  1350. ERR_FAIL_COND_V_MSG(err, TextureID(), "vkCreateImageView failed with error " + itos(err) + ".");
  1351. }
  1352. // Bookkeep.
  1353. TextureInfo *tex_info = VersatileResource::allocate<TextureInfo>(resources_allocator);
  1354. tex_info->vk_view = vk_image_view;
  1355. tex_info->rd_format = p_format;
  1356. tex_info->vk_view_create_info = image_view_create_info;
  1357. return TextureID(tex_info);
  1358. }
  1359. RDD::TextureID RenderingDeviceDriverVulkan::texture_create_shared(TextureID p_original_texture, const TextureView &p_view) {
  1360. const TextureInfo *owner_tex_info = (const TextureInfo *)p_original_texture.id;
  1361. #ifdef DEBUG_ENABLED
  1362. ERR_FAIL_COND_V(!owner_tex_info->allocation.handle, TextureID());
  1363. #endif
  1364. VkImageViewCreateInfo image_view_create_info = owner_tex_info->vk_view_create_info;
  1365. image_view_create_info.format = RD_TO_VK_FORMAT[p_view.format];
  1366. image_view_create_info.components.r = (VkComponentSwizzle)p_view.swizzle_r;
  1367. image_view_create_info.components.g = (VkComponentSwizzle)p_view.swizzle_g;
  1368. image_view_create_info.components.b = (VkComponentSwizzle)p_view.swizzle_b;
  1369. image_view_create_info.components.a = (VkComponentSwizzle)p_view.swizzle_a;
  1370. if (enabled_device_extension_names.has(VK_KHR_MAINTENANCE_2_EXTENSION_NAME)) {
  1371. // May need to make VK_KHR_maintenance2 mandatory and thus has Vulkan 1.1 be our minimum supported version
  1372. // if we require setting this information. Vulkan 1.0 may simply not care.
  1373. if (image_view_create_info.format != owner_tex_info->vk_view_create_info.format) {
  1374. VkImageViewUsageCreateInfo *usage_info = ALLOCA_SINGLE(VkImageViewUsageCreateInfo);
  1375. *usage_info = {};
  1376. usage_info->sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_USAGE_CREATE_INFO;
  1377. usage_info->usage = owner_tex_info->vk_create_info.usage;
  1378. // Certain features may not be available for the format of the view.
  1379. {
  1380. VkFormatProperties properties = {};
  1381. vkGetPhysicalDeviceFormatProperties(physical_device, RD_TO_VK_FORMAT[p_view.format], &properties);
  1382. const VkFormatFeatureFlags &supported_flags = owner_tex_info->vk_create_info.tiling == VK_IMAGE_TILING_LINEAR ? properties.linearTilingFeatures : properties.optimalTilingFeatures;
  1383. if ((usage_info->usage & VK_IMAGE_USAGE_STORAGE_BIT) && !(supported_flags & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
  1384. usage_info->usage &= ~VK_IMAGE_USAGE_STORAGE_BIT;
  1385. }
  1386. if ((usage_info->usage & VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT) && !(supported_flags & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
  1387. usage_info->usage &= ~VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
  1388. }
  1389. }
  1390. image_view_create_info.pNext = usage_info;
  1391. }
  1392. }
  1393. VkImageView new_vk_image_view = VK_NULL_HANDLE;
  1394. VkResult err = vkCreateImageView(vk_device, &image_view_create_info, nullptr, &new_vk_image_view);
  1395. ERR_FAIL_COND_V_MSG(err, TextureID(), "vkCreateImageView failed with error " + itos(err) + ".");
  1396. // Bookkeep.
  1397. TextureInfo *tex_info = VersatileResource::allocate<TextureInfo>(resources_allocator);
  1398. *tex_info = *owner_tex_info;
  1399. tex_info->vk_view = new_vk_image_view;
  1400. tex_info->vk_view_create_info = image_view_create_info;
  1401. tex_info->allocation = {};
  1402. #if PRINT_NATIVE_COMMANDS
  1403. print_line(vformat("vkCreateImageView: 0x%uX for 0x%uX", uint64_t(new_vk_image_view), uint64_t(owner_tex_info->vk_view_create_info.image)));
  1404. #endif
  1405. return TextureID(tex_info);
  1406. }
  1407. RDD::TextureID RenderingDeviceDriverVulkan::texture_create_shared_from_slice(TextureID p_original_texture, const TextureView &p_view, TextureSliceType p_slice_type, uint32_t p_layer, uint32_t p_layers, uint32_t p_mipmap, uint32_t p_mipmaps) {
  1408. const TextureInfo *owner_tex_info = (const TextureInfo *)p_original_texture.id;
  1409. #ifdef DEBUG_ENABLED
  1410. ERR_FAIL_COND_V(!owner_tex_info->allocation.handle, TextureID());
  1411. #endif
  1412. VkImageViewCreateInfo image_view_create_info = owner_tex_info->vk_view_create_info;
  1413. switch (p_slice_type) {
  1414. case TEXTURE_SLICE_2D: {
  1415. image_view_create_info.viewType = VK_IMAGE_VIEW_TYPE_2D;
  1416. } break;
  1417. case TEXTURE_SLICE_3D: {
  1418. image_view_create_info.viewType = VK_IMAGE_VIEW_TYPE_3D;
  1419. } break;
  1420. case TEXTURE_SLICE_CUBEMAP: {
  1421. image_view_create_info.viewType = VK_IMAGE_VIEW_TYPE_CUBE;
  1422. } break;
  1423. case TEXTURE_SLICE_2D_ARRAY: {
  1424. image_view_create_info.viewType = VK_IMAGE_VIEW_TYPE_2D_ARRAY;
  1425. } break;
  1426. default: {
  1427. return TextureID(nullptr);
  1428. }
  1429. }
  1430. image_view_create_info.format = RD_TO_VK_FORMAT[p_view.format];
  1431. image_view_create_info.components.r = (VkComponentSwizzle)p_view.swizzle_r;
  1432. image_view_create_info.components.g = (VkComponentSwizzle)p_view.swizzle_g;
  1433. image_view_create_info.components.b = (VkComponentSwizzle)p_view.swizzle_b;
  1434. image_view_create_info.components.a = (VkComponentSwizzle)p_view.swizzle_a;
  1435. image_view_create_info.subresourceRange.baseMipLevel = p_mipmap;
  1436. image_view_create_info.subresourceRange.levelCount = p_mipmaps;
  1437. image_view_create_info.subresourceRange.baseArrayLayer = p_layer;
  1438. image_view_create_info.subresourceRange.layerCount = p_layers;
  1439. VkImageView new_vk_image_view = VK_NULL_HANDLE;
  1440. VkResult err = vkCreateImageView(vk_device, &image_view_create_info, nullptr, &new_vk_image_view);
  1441. ERR_FAIL_COND_V_MSG(err, TextureID(), "vkCreateImageView failed with error " + itos(err) + ".");
  1442. // Bookkeep.
  1443. TextureInfo *tex_info = VersatileResource::allocate<TextureInfo>(resources_allocator);
  1444. *tex_info = *owner_tex_info;
  1445. tex_info->vk_view = new_vk_image_view;
  1446. tex_info->vk_view_create_info = image_view_create_info;
  1447. tex_info->allocation = {};
  1448. #if PRINT_NATIVE_COMMANDS
  1449. print_line(vformat("vkCreateImageView: 0x%uX for 0x%uX (%d %d %d %d)", uint64_t(new_vk_image_view), uint64_t(owner_tex_info->vk_view_create_info.image), p_mipmap, p_mipmaps, p_layer, p_layers));
  1450. #endif
  1451. return TextureID(tex_info);
  1452. }
  1453. void RenderingDeviceDriverVulkan::texture_free(TextureID p_texture) {
  1454. TextureInfo *tex_info = (TextureInfo *)p_texture.id;
  1455. vkDestroyImageView(vk_device, tex_info->vk_view, nullptr);
  1456. if (tex_info->allocation.handle) {
  1457. vmaDestroyImage(allocator, tex_info->vk_view_create_info.image, tex_info->allocation.handle);
  1458. }
  1459. VersatileResource::free(resources_allocator, tex_info);
  1460. }
  1461. uint64_t RenderingDeviceDriverVulkan::texture_get_allocation_size(TextureID p_texture) {
  1462. const TextureInfo *tex_info = (const TextureInfo *)p_texture.id;
  1463. return tex_info->allocation.info.size;
  1464. }
  1465. void RenderingDeviceDriverVulkan::texture_get_copyable_layout(TextureID p_texture, const TextureSubresource &p_subresource, TextureCopyableLayout *r_layout) {
  1466. const TextureInfo *tex_info = (const TextureInfo *)p_texture.id;
  1467. *r_layout = {};
  1468. if (tex_info->vk_create_info.tiling == VK_IMAGE_TILING_LINEAR) {
  1469. VkImageSubresource vk_subres = {};
  1470. vk_subres.aspectMask = (VkImageAspectFlags)(1 << p_subresource.aspect);
  1471. vk_subres.arrayLayer = p_subresource.layer;
  1472. vk_subres.mipLevel = p_subresource.mipmap;
  1473. VkSubresourceLayout vk_layout = {};
  1474. vkGetImageSubresourceLayout(vk_device, tex_info->vk_view_create_info.image, &vk_subres, &vk_layout);
  1475. r_layout->offset = vk_layout.offset;
  1476. r_layout->size = vk_layout.size;
  1477. r_layout->row_pitch = vk_layout.rowPitch;
  1478. r_layout->depth_pitch = vk_layout.depthPitch;
  1479. r_layout->layer_pitch = vk_layout.arrayPitch;
  1480. } else {
  1481. // Tight.
  1482. uint32_t w = tex_info->vk_create_info.extent.width;
  1483. uint32_t h = tex_info->vk_create_info.extent.height;
  1484. uint32_t d = tex_info->vk_create_info.extent.depth;
  1485. if (p_subresource.mipmap > 0) {
  1486. r_layout->offset = get_image_format_required_size(tex_info->rd_format, w, h, d, p_subresource.mipmap);
  1487. }
  1488. for (uint32_t i = 0; i < p_subresource.mipmap; i++) {
  1489. w = MAX(1u, w >> 1);
  1490. h = MAX(1u, h >> 1);
  1491. d = MAX(1u, d >> 1);
  1492. }
  1493. uint32_t bw = 0, bh = 0;
  1494. get_compressed_image_format_block_dimensions(tex_info->rd_format, bw, bh);
  1495. uint32_t sbw = 0, sbh = 0;
  1496. r_layout->size = get_image_format_required_size(tex_info->rd_format, w, h, d, 1, &sbw, &sbh);
  1497. r_layout->row_pitch = r_layout->size / ((sbh / bh) * d);
  1498. r_layout->depth_pitch = r_layout->size / d;
  1499. r_layout->layer_pitch = r_layout->size / tex_info->vk_create_info.arrayLayers;
  1500. }
  1501. }
  1502. uint8_t *RenderingDeviceDriverVulkan::texture_map(TextureID p_texture, const TextureSubresource &p_subresource) {
  1503. const TextureInfo *tex_info = (const TextureInfo *)p_texture.id;
  1504. VkImageSubresource vk_subres = {};
  1505. vk_subres.aspectMask = (VkImageAspectFlags)(1 << p_subresource.aspect);
  1506. vk_subres.arrayLayer = p_subresource.layer;
  1507. vk_subres.mipLevel = p_subresource.mipmap;
  1508. VkSubresourceLayout vk_layout = {};
  1509. vkGetImageSubresourceLayout(vk_device, tex_info->vk_view_create_info.image, &vk_subres, &vk_layout);
  1510. void *data_ptr = nullptr;
  1511. VkResult err = vkMapMemory(
  1512. vk_device,
  1513. tex_info->allocation.info.deviceMemory,
  1514. tex_info->allocation.info.offset + vk_layout.offset,
  1515. vk_layout.size,
  1516. 0,
  1517. &data_ptr);
  1518. vmaMapMemory(allocator, tex_info->allocation.handle, &data_ptr);
  1519. ERR_FAIL_COND_V_MSG(err, nullptr, "vkMapMemory failed with error " + itos(err) + ".");
  1520. return (uint8_t *)data_ptr;
  1521. }
  1522. void RenderingDeviceDriverVulkan::texture_unmap(TextureID p_texture) {
  1523. const TextureInfo *tex_info = (const TextureInfo *)p_texture.id;
  1524. vkUnmapMemory(vk_device, tex_info->allocation.info.deviceMemory);
  1525. }
  1526. BitField<RDD::TextureUsageBits> RenderingDeviceDriverVulkan::texture_get_usages_supported_by_format(DataFormat p_format, bool p_cpu_readable) {
  1527. VkFormatProperties properties = {};
  1528. vkGetPhysicalDeviceFormatProperties(physical_device, RD_TO_VK_FORMAT[p_format], &properties);
  1529. const VkFormatFeatureFlags &flags = p_cpu_readable ? properties.linearTilingFeatures : properties.optimalTilingFeatures;
  1530. // Everything supported by default makes an all-or-nothing check easier for the caller.
  1531. BitField<RDD::TextureUsageBits> supported = INT64_MAX;
  1532. if (!(flags & VK_FORMAT_FEATURE_SAMPLED_IMAGE_BIT)) {
  1533. supported.clear_flag(TEXTURE_USAGE_SAMPLING_BIT);
  1534. }
  1535. if (!(flags & VK_FORMAT_FEATURE_COLOR_ATTACHMENT_BIT)) {
  1536. supported.clear_flag(TEXTURE_USAGE_COLOR_ATTACHMENT_BIT);
  1537. }
  1538. if (!(flags & VK_FORMAT_FEATURE_DEPTH_STENCIL_ATTACHMENT_BIT)) {
  1539. supported.clear_flag(TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT);
  1540. }
  1541. if (!(flags & VK_FORMAT_FEATURE_STORAGE_IMAGE_BIT)) {
  1542. supported.clear_flag(TEXTURE_USAGE_STORAGE_BIT);
  1543. }
  1544. if (!(flags & VK_FORMAT_FEATURE_STORAGE_IMAGE_ATOMIC_BIT)) {
  1545. supported.clear_flag(TEXTURE_USAGE_STORAGE_ATOMIC_BIT);
  1546. }
  1547. // Validation via VK_FORMAT_FEATURE_FRAGMENT_SHADING_RATE_ATTACHMENT_BIT_KHR fails if VRS attachment is not supported.
  1548. if (p_format != DATA_FORMAT_R8_UINT) {
  1549. supported.clear_flag(TEXTURE_USAGE_VRS_ATTACHMENT_BIT);
  1550. }
  1551. return supported;
  1552. }
  1553. /*****************/
  1554. /**** SAMPLER ****/
  1555. /*****************/
  1556. // RDD::SamplerRepeatMode == VkSamplerAddressMode.
  1557. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_REPEAT_MODE_REPEAT, VK_SAMPLER_ADDRESS_MODE_REPEAT));
  1558. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_REPEAT_MODE_MIRRORED_REPEAT, VK_SAMPLER_ADDRESS_MODE_MIRRORED_REPEAT));
  1559. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE, VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE));
  1560. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER, VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_BORDER));
  1561. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE, VK_SAMPLER_ADDRESS_MODE_MIRROR_CLAMP_TO_EDGE));
  1562. // RDD::SamplerBorderColor == VkBorderColor.
  1563. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK, VK_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK));
  1564. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK, VK_BORDER_COLOR_INT_TRANSPARENT_BLACK));
  1565. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK, VK_BORDER_COLOR_FLOAT_OPAQUE_BLACK));
  1566. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK, VK_BORDER_COLOR_INT_OPAQUE_BLACK));
  1567. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE, VK_BORDER_COLOR_FLOAT_OPAQUE_WHITE));
  1568. static_assert(ENUM_MEMBERS_EQUAL(RDD::SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE, VK_BORDER_COLOR_INT_OPAQUE_WHITE));
  1569. RDD::SamplerID RenderingDeviceDriverVulkan::sampler_create(const SamplerState &p_state) {
  1570. VkSamplerCreateInfo sampler_create_info = {};
  1571. sampler_create_info.sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO;
  1572. sampler_create_info.pNext = nullptr;
  1573. sampler_create_info.flags = 0;
  1574. sampler_create_info.magFilter = p_state.mag_filter == SAMPLER_FILTER_LINEAR ? VK_FILTER_LINEAR : VK_FILTER_NEAREST;
  1575. sampler_create_info.minFilter = p_state.min_filter == SAMPLER_FILTER_LINEAR ? VK_FILTER_LINEAR : VK_FILTER_NEAREST;
  1576. sampler_create_info.mipmapMode = p_state.mip_filter == SAMPLER_FILTER_LINEAR ? VK_SAMPLER_MIPMAP_MODE_LINEAR : VK_SAMPLER_MIPMAP_MODE_NEAREST;
  1577. sampler_create_info.addressModeU = (VkSamplerAddressMode)p_state.repeat_u;
  1578. sampler_create_info.addressModeV = (VkSamplerAddressMode)p_state.repeat_v;
  1579. sampler_create_info.addressModeW = (VkSamplerAddressMode)p_state.repeat_w;
  1580. sampler_create_info.mipLodBias = p_state.lod_bias;
  1581. sampler_create_info.anisotropyEnable = p_state.use_anisotropy && (physical_device_features.samplerAnisotropy == VK_TRUE);
  1582. sampler_create_info.maxAnisotropy = p_state.anisotropy_max;
  1583. sampler_create_info.compareEnable = p_state.enable_compare;
  1584. sampler_create_info.compareOp = (VkCompareOp)p_state.compare_op;
  1585. sampler_create_info.minLod = p_state.min_lod;
  1586. sampler_create_info.maxLod = p_state.max_lod;
  1587. sampler_create_info.borderColor = (VkBorderColor)p_state.border_color;
  1588. sampler_create_info.unnormalizedCoordinates = p_state.unnormalized_uvw;
  1589. VkSampler vk_sampler = VK_NULL_HANDLE;
  1590. VkResult res = vkCreateSampler(vk_device, &sampler_create_info, nullptr, &vk_sampler);
  1591. ERR_FAIL_COND_V_MSG(res, SamplerID(), "vkCreateSampler failed with error " + itos(res) + ".");
  1592. return SamplerID(vk_sampler);
  1593. }
  1594. void RenderingDeviceDriverVulkan::sampler_free(SamplerID p_sampler) {
  1595. vkDestroySampler(vk_device, (VkSampler)p_sampler.id, nullptr);
  1596. }
  1597. bool RenderingDeviceDriverVulkan::sampler_is_format_supported_for_filter(DataFormat p_format, SamplerFilter p_filter) {
  1598. switch (p_filter) {
  1599. case SAMPLER_FILTER_NEAREST: {
  1600. return true;
  1601. }
  1602. case SAMPLER_FILTER_LINEAR: {
  1603. VkFormatProperties properties = {};
  1604. vkGetPhysicalDeviceFormatProperties(physical_device, RD_TO_VK_FORMAT[p_format], &properties);
  1605. return (properties.optimalTilingFeatures & VK_FORMAT_FEATURE_SAMPLED_IMAGE_FILTER_LINEAR_BIT);
  1606. }
  1607. }
  1608. return false;
  1609. }
  1610. /**********************/
  1611. /**** VERTEX ARRAY ****/
  1612. /**********************/
  1613. RDD::VertexFormatID RenderingDeviceDriverVulkan::vertex_format_create(VectorView<VertexAttribute> p_vertex_attribs) {
  1614. // Pre-bookkeep.
  1615. VertexFormatInfo *vf_info = VersatileResource::allocate<VertexFormatInfo>(resources_allocator);
  1616. vf_info->vk_bindings.resize(p_vertex_attribs.size());
  1617. vf_info->vk_attributes.resize(p_vertex_attribs.size());
  1618. for (uint32_t i = 0; i < p_vertex_attribs.size(); i++) {
  1619. vf_info->vk_bindings[i] = {};
  1620. vf_info->vk_bindings[i].binding = i;
  1621. vf_info->vk_bindings[i].stride = p_vertex_attribs[i].stride;
  1622. vf_info->vk_bindings[i].inputRate = p_vertex_attribs[i].frequency == VERTEX_FREQUENCY_INSTANCE ? VK_VERTEX_INPUT_RATE_INSTANCE : VK_VERTEX_INPUT_RATE_VERTEX;
  1623. vf_info->vk_attributes[i] = {};
  1624. vf_info->vk_attributes[i].binding = i;
  1625. vf_info->vk_attributes[i].location = p_vertex_attribs[i].location;
  1626. vf_info->vk_attributes[i].format = RD_TO_VK_FORMAT[p_vertex_attribs[i].format];
  1627. vf_info->vk_attributes[i].offset = p_vertex_attribs[i].offset;
  1628. }
  1629. vf_info->vk_create_info = {};
  1630. vf_info->vk_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO;
  1631. vf_info->vk_create_info.vertexBindingDescriptionCount = vf_info->vk_bindings.size();
  1632. vf_info->vk_create_info.pVertexBindingDescriptions = vf_info->vk_bindings.ptr();
  1633. vf_info->vk_create_info.vertexAttributeDescriptionCount = vf_info->vk_attributes.size();
  1634. vf_info->vk_create_info.pVertexAttributeDescriptions = vf_info->vk_attributes.ptr();
  1635. return VertexFormatID(vf_info);
  1636. }
  1637. void RenderingDeviceDriverVulkan::vertex_format_free(VertexFormatID p_vertex_format) {
  1638. VertexFormatInfo *vf_info = (VertexFormatInfo *)p_vertex_format.id;
  1639. VersatileResource::free(resources_allocator, vf_info);
  1640. }
  1641. /******************/
  1642. /**** BARRIERS ****/
  1643. /******************/
  1644. // RDD::PipelineStageBits == VkPipelineStageFlagBits.
  1645. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_TOP_OF_PIPE_BIT, VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT));
  1646. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_DRAW_INDIRECT_BIT, VK_PIPELINE_STAGE_DRAW_INDIRECT_BIT));
  1647. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_VERTEX_INPUT_BIT, VK_PIPELINE_STAGE_VERTEX_INPUT_BIT));
  1648. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_VERTEX_SHADER_BIT, VK_PIPELINE_STAGE_VERTEX_SHADER_BIT));
  1649. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT, VK_PIPELINE_STAGE_TESSELLATION_CONTROL_SHADER_BIT));
  1650. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT, VK_PIPELINE_STAGE_TESSELLATION_EVALUATION_SHADER_BIT));
  1651. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_GEOMETRY_SHADER_BIT, VK_PIPELINE_STAGE_GEOMETRY_SHADER_BIT));
  1652. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_FRAGMENT_SHADER_BIT, VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT));
  1653. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT, VK_PIPELINE_STAGE_EARLY_FRAGMENT_TESTS_BIT));
  1654. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT, VK_PIPELINE_STAGE_LATE_FRAGMENT_TESTS_BIT));
  1655. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT, VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT));
  1656. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_COMPUTE_SHADER_BIT, VK_PIPELINE_STAGE_COMPUTE_SHADER_BIT));
  1657. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_TRANSFER_BIT, VK_PIPELINE_STAGE_TRANSFER_BIT));
  1658. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT));
  1659. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_ALL_GRAPHICS_BIT, VK_PIPELINE_STAGE_ALL_GRAPHICS_BIT));
  1660. static_assert(ENUM_MEMBERS_EQUAL(RDD::PIPELINE_STAGE_ALL_COMMANDS_BIT, VK_PIPELINE_STAGE_ALL_COMMANDS_BIT));
  1661. // RDD::BarrierAccessBits == VkAccessFlagBits.
  1662. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_INDIRECT_COMMAND_READ_BIT, VK_ACCESS_INDIRECT_COMMAND_READ_BIT));
  1663. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_INDEX_READ_BIT, VK_ACCESS_INDEX_READ_BIT));
  1664. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_VERTEX_ATTRIBUTE_READ_BIT, VK_ACCESS_VERTEX_ATTRIBUTE_READ_BIT));
  1665. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_UNIFORM_READ_BIT, VK_ACCESS_UNIFORM_READ_BIT));
  1666. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_INPUT_ATTACHMENT_READ_BIT, VK_ACCESS_INPUT_ATTACHMENT_READ_BIT));
  1667. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_SHADER_READ_BIT, VK_ACCESS_SHADER_READ_BIT));
  1668. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_SHADER_WRITE_BIT, VK_ACCESS_SHADER_WRITE_BIT));
  1669. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_COLOR_ATTACHMENT_READ_BIT, VK_ACCESS_COLOR_ATTACHMENT_READ_BIT));
  1670. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_COLOR_ATTACHMENT_WRITE_BIT, VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT));
  1671. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_READ_BIT));
  1672. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT, VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT));
  1673. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_TRANSFER_READ_BIT, VK_ACCESS_TRANSFER_READ_BIT));
  1674. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_TRANSFER_WRITE_BIT, VK_ACCESS_TRANSFER_WRITE_BIT));
  1675. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_HOST_READ_BIT, VK_ACCESS_HOST_READ_BIT));
  1676. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_HOST_WRITE_BIT, VK_ACCESS_HOST_WRITE_BIT));
  1677. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_MEMORY_READ_BIT, VK_ACCESS_MEMORY_READ_BIT));
  1678. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_MEMORY_WRITE_BIT, VK_ACCESS_MEMORY_WRITE_BIT));
  1679. static_assert(ENUM_MEMBERS_EQUAL(RDD::BARRIER_ACCESS_FRAGMENT_SHADING_RATE_ATTACHMENT_READ_BIT, VK_ACCESS_FRAGMENT_SHADING_RATE_ATTACHMENT_READ_BIT_KHR));
  1680. void RenderingDeviceDriverVulkan::command_pipeline_barrier(
  1681. CommandBufferID p_cmd_buffer,
  1682. BitField<PipelineStageBits> p_src_stages,
  1683. BitField<PipelineStageBits> p_dst_stages,
  1684. VectorView<MemoryBarrier> p_memory_barriers,
  1685. VectorView<BufferBarrier> p_buffer_barriers,
  1686. VectorView<TextureBarrier> p_texture_barriers) {
  1687. VkMemoryBarrier *vk_memory_barriers = ALLOCA_ARRAY(VkMemoryBarrier, p_memory_barriers.size());
  1688. for (uint32_t i = 0; i < p_memory_barriers.size(); i++) {
  1689. vk_memory_barriers[i] = {};
  1690. vk_memory_barriers[i].sType = VK_STRUCTURE_TYPE_MEMORY_BARRIER;
  1691. vk_memory_barriers[i].srcAccessMask = (VkPipelineStageFlags)p_memory_barriers[i].src_access;
  1692. vk_memory_barriers[i].dstAccessMask = (VkAccessFlags)p_memory_barriers[i].dst_access;
  1693. }
  1694. VkBufferMemoryBarrier *vk_buffer_barriers = ALLOCA_ARRAY(VkBufferMemoryBarrier, p_buffer_barriers.size());
  1695. for (uint32_t i = 0; i < p_buffer_barriers.size(); i++) {
  1696. vk_buffer_barriers[i] = {};
  1697. vk_buffer_barriers[i].sType = VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER;
  1698. vk_buffer_barriers[i].srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  1699. vk_buffer_barriers[i].dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  1700. vk_buffer_barriers[i].srcAccessMask = (VkAccessFlags)p_buffer_barriers[i].src_access;
  1701. vk_buffer_barriers[i].dstAccessMask = (VkAccessFlags)p_buffer_barriers[i].dst_access;
  1702. vk_buffer_barriers[i].buffer = ((const BufferInfo *)p_buffer_barriers[i].buffer.id)->vk_buffer;
  1703. vk_buffer_barriers[i].offset = p_buffer_barriers[i].offset;
  1704. vk_buffer_barriers[i].size = p_buffer_barriers[i].size;
  1705. }
  1706. VkImageMemoryBarrier *vk_image_barriers = ALLOCA_ARRAY(VkImageMemoryBarrier, p_texture_barriers.size());
  1707. for (uint32_t i = 0; i < p_texture_barriers.size(); i++) {
  1708. const TextureInfo *tex_info = (const TextureInfo *)p_texture_barriers[i].texture.id;
  1709. vk_image_barriers[i] = {};
  1710. vk_image_barriers[i].sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
  1711. vk_image_barriers[i].srcAccessMask = (VkAccessFlags)p_texture_barriers[i].src_access;
  1712. vk_image_barriers[i].dstAccessMask = (VkAccessFlags)p_texture_barriers[i].dst_access;
  1713. vk_image_barriers[i].oldLayout = (VkImageLayout)p_texture_barriers[i].prev_layout;
  1714. vk_image_barriers[i].newLayout = (VkImageLayout)p_texture_barriers[i].next_layout;
  1715. vk_image_barriers[i].srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  1716. vk_image_barriers[i].dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  1717. vk_image_barriers[i].image = tex_info->vk_view_create_info.image;
  1718. vk_image_barriers[i].subresourceRange.aspectMask = (VkImageAspectFlags)p_texture_barriers[i].subresources.aspect;
  1719. vk_image_barriers[i].subresourceRange.baseMipLevel = p_texture_barriers[i].subresources.base_mipmap;
  1720. vk_image_barriers[i].subresourceRange.levelCount = p_texture_barriers[i].subresources.mipmap_count;
  1721. vk_image_barriers[i].subresourceRange.baseArrayLayer = p_texture_barriers[i].subresources.base_layer;
  1722. vk_image_barriers[i].subresourceRange.layerCount = p_texture_barriers[i].subresources.layer_count;
  1723. }
  1724. #if PRINT_NATIVE_COMMANDS
  1725. print_line(vformat("vkCmdPipelineBarrier MEMORY %d BUFFER %d TEXTURE %d", p_memory_barriers.size(), p_buffer_barriers.size(), p_texture_barriers.size()));
  1726. for (uint32_t i = 0; i < p_memory_barriers.size(); i++) {
  1727. print_line(vformat(" VkMemoryBarrier #%d src 0x%uX dst 0x%uX", i, vk_memory_barriers[i].srcAccessMask, vk_memory_barriers[i].dstAccessMask));
  1728. }
  1729. for (uint32_t i = 0; i < p_buffer_barriers.size(); i++) {
  1730. print_line(vformat(" VkBufferMemoryBarrier #%d src 0x%uX dst 0x%uX buffer 0x%ux", i, vk_buffer_barriers[i].srcAccessMask, vk_buffer_barriers[i].dstAccessMask, uint64_t(vk_buffer_barriers[i].buffer)));
  1731. }
  1732. for (uint32_t i = 0; i < p_texture_barriers.size(); i++) {
  1733. print_line(vformat(" VkImageMemoryBarrier #%d src 0x%uX dst 0x%uX image 0x%ux old %d new %d (%d %d %d %d)", i, vk_image_barriers[i].srcAccessMask, vk_image_barriers[i].dstAccessMask,
  1734. uint64_t(vk_image_barriers[i].image), vk_image_barriers[i].oldLayout, vk_image_barriers[i].newLayout, vk_image_barriers[i].subresourceRange.baseMipLevel, vk_image_barriers[i].subresourceRange.levelCount,
  1735. vk_image_barriers[i].subresourceRange.baseArrayLayer, vk_image_barriers[i].subresourceRange.layerCount));
  1736. }
  1737. #endif
  1738. vkCmdPipelineBarrier(
  1739. (VkCommandBuffer)p_cmd_buffer.id,
  1740. (VkPipelineStageFlags)p_src_stages,
  1741. (VkPipelineStageFlags)p_dst_stages,
  1742. 0,
  1743. p_memory_barriers.size(), vk_memory_barriers,
  1744. p_buffer_barriers.size(), vk_buffer_barriers,
  1745. p_texture_barriers.size(), vk_image_barriers);
  1746. }
  1747. /****************/
  1748. /**** FENCES ****/
  1749. /****************/
  1750. RDD::FenceID RenderingDeviceDriverVulkan::fence_create() {
  1751. VkFence vk_fence = VK_NULL_HANDLE;
  1752. VkFenceCreateInfo create_info = {};
  1753. create_info.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO;
  1754. VkResult err = vkCreateFence(vk_device, &create_info, nullptr, &vk_fence);
  1755. ERR_FAIL_COND_V(err != VK_SUCCESS, FenceID());
  1756. Fence *fence = memnew(Fence);
  1757. fence->vk_fence = vk_fence;
  1758. fence->queue_signaled_from = nullptr;
  1759. return FenceID(fence);
  1760. }
  1761. Error RenderingDeviceDriverVulkan::fence_wait(FenceID p_fence) {
  1762. Fence *fence = (Fence *)(p_fence.id);
  1763. VkResult err = vkWaitForFences(vk_device, 1, &fence->vk_fence, VK_TRUE, UINT64_MAX);
  1764. ERR_FAIL_COND_V(err != VK_SUCCESS, FAILED);
  1765. err = vkResetFences(vk_device, 1, &fence->vk_fence);
  1766. ERR_FAIL_COND_V(err != VK_SUCCESS, FAILED);
  1767. if (fence->queue_signaled_from != nullptr) {
  1768. // Release all semaphores that the command queue associated to the fence waited on the last time it was submitted.
  1769. LocalVector<Pair<Fence *, uint32_t>> &pairs = fence->queue_signaled_from->image_semaphores_for_fences;
  1770. uint32_t i = 0;
  1771. while (i < pairs.size()) {
  1772. if (pairs[i].first == fence) {
  1773. _release_image_semaphore(fence->queue_signaled_from, pairs[i].second, true);
  1774. fence->queue_signaled_from->free_image_semaphores.push_back(pairs[i].second);
  1775. pairs.remove_at(i);
  1776. } else {
  1777. i++;
  1778. }
  1779. }
  1780. fence->queue_signaled_from = nullptr;
  1781. }
  1782. return OK;
  1783. }
  1784. void RenderingDeviceDriverVulkan::fence_free(FenceID p_fence) {
  1785. Fence *fence = (Fence *)(p_fence.id);
  1786. vkDestroyFence(vk_device, fence->vk_fence, nullptr);
  1787. memdelete(fence);
  1788. }
  1789. /********************/
  1790. /**** SEMAPHORES ****/
  1791. /********************/
  1792. RDD::SemaphoreID RenderingDeviceDriverVulkan::semaphore_create() {
  1793. VkSemaphore semaphore = VK_NULL_HANDLE;
  1794. VkSemaphoreCreateInfo create_info = {};
  1795. create_info.sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO;
  1796. VkResult err = vkCreateSemaphore(vk_device, &create_info, nullptr, &semaphore);
  1797. ERR_FAIL_COND_V(err != VK_SUCCESS, SemaphoreID());
  1798. return SemaphoreID(semaphore);
  1799. }
  1800. void RenderingDeviceDriverVulkan::semaphore_free(SemaphoreID p_semaphore) {
  1801. vkDestroySemaphore(vk_device, VkSemaphore(p_semaphore.id), nullptr);
  1802. }
  1803. /******************/
  1804. /**** COMMANDS ****/
  1805. /******************/
  1806. // ----- QUEUE FAMILY -----
  1807. RDD::CommandQueueFamilyID RenderingDeviceDriverVulkan::command_queue_family_get(BitField<CommandQueueFamilyBits> p_cmd_queue_family_bits, RenderingContextDriver::SurfaceID p_surface) {
  1808. // Pick the queue with the least amount of bits that can fulfill the requirements.
  1809. VkQueueFlags picked_queue_flags = VK_QUEUE_FLAG_BITS_MAX_ENUM;
  1810. uint32_t picked_family_index = UINT_MAX;
  1811. for (uint32_t i = 0; i < queue_family_properties.size(); i++) {
  1812. if (queue_families[i].is_empty()) {
  1813. // Ignore empty queue families.
  1814. continue;
  1815. }
  1816. if (p_surface != 0 && !context_driver->queue_family_supports_present(physical_device, i, p_surface)) {
  1817. // Present is not an actual bit but something that must be queried manually.
  1818. continue;
  1819. }
  1820. // Preferring a queue with less bits will get us closer to getting a queue that performs better for our requirements.
  1821. // For example, dedicated compute and transfer queues are usually indicated as such.
  1822. const VkQueueFlags option_queue_flags = queue_family_properties[i].queueFlags;
  1823. const bool includes_all_bits = (option_queue_flags & p_cmd_queue_family_bits) == p_cmd_queue_family_bits;
  1824. const bool prefer_less_bits = option_queue_flags < picked_queue_flags;
  1825. if (includes_all_bits && prefer_less_bits) {
  1826. picked_family_index = i;
  1827. picked_queue_flags = option_queue_flags;
  1828. }
  1829. }
  1830. ERR_FAIL_COND_V_MSG(picked_family_index >= queue_family_properties.size(), CommandQueueFamilyID(), "A queue family with the requested bits could not be found.");
  1831. // Since 0 is a valid index and we use 0 as the error case, we make the index start from 1 instead.
  1832. return CommandQueueFamilyID(picked_family_index + 1);
  1833. }
  1834. // ----- QUEUE -----
  1835. RDD::CommandQueueID RenderingDeviceDriverVulkan::command_queue_create(CommandQueueFamilyID p_cmd_queue_family, bool p_identify_as_main_queue) {
  1836. DEV_ASSERT(p_cmd_queue_family.id != 0);
  1837. // Make a virtual queue on top of a real queue. Use the queue from the family with the least amount of virtual queues created.
  1838. uint32_t family_index = p_cmd_queue_family.id - 1;
  1839. TightLocalVector<Queue> &queue_family = queue_families[family_index];
  1840. uint32_t picked_queue_index = UINT_MAX;
  1841. uint32_t picked_virtual_count = UINT_MAX;
  1842. for (uint32_t i = 0; i < queue_family.size(); i++) {
  1843. if (queue_family[i].virtual_count < picked_virtual_count) {
  1844. picked_queue_index = i;
  1845. picked_virtual_count = queue_family[i].virtual_count;
  1846. }
  1847. }
  1848. ERR_FAIL_COND_V_MSG(picked_queue_index >= queue_family.size(), CommandQueueID(), "A queue in the picked family could not be found.");
  1849. // Create the virtual queue.
  1850. CommandQueue *command_queue = memnew(CommandQueue);
  1851. command_queue->queue_family = family_index;
  1852. command_queue->queue_index = picked_queue_index;
  1853. queue_family[picked_queue_index].virtual_count++;
  1854. // If is was identified as the main queue and a hook is active, indicate it as such to the hook.
  1855. if (p_identify_as_main_queue && (VulkanHooks::get_singleton() != nullptr)) {
  1856. VulkanHooks::get_singleton()->set_direct_queue_family_and_index(family_index, picked_queue_index);
  1857. }
  1858. return CommandQueueID(command_queue);
  1859. }
  1860. Error RenderingDeviceDriverVulkan::command_queue_execute_and_present(CommandQueueID p_cmd_queue, VectorView<SemaphoreID> p_wait_semaphores, VectorView<CommandBufferID> p_cmd_buffers, VectorView<SemaphoreID> p_cmd_semaphores, FenceID p_cmd_fence, VectorView<SwapChainID> p_swap_chains) {
  1861. DEV_ASSERT(p_cmd_queue.id != 0);
  1862. VkResult err;
  1863. CommandQueue *command_queue = (CommandQueue *)(p_cmd_queue.id);
  1864. Queue &device_queue = queue_families[command_queue->queue_family][command_queue->queue_index];
  1865. Fence *fence = (Fence *)(p_cmd_fence.id);
  1866. VkFence vk_fence = (fence != nullptr) ? fence->vk_fence : VK_NULL_HANDLE;
  1867. thread_local LocalVector<VkSemaphore> wait_semaphores;
  1868. thread_local LocalVector<VkPipelineStageFlags> wait_semaphores_stages;
  1869. wait_semaphores.clear();
  1870. wait_semaphores_stages.clear();
  1871. if (!command_queue->pending_semaphores_for_execute.is_empty()) {
  1872. for (uint32_t i = 0; i < command_queue->pending_semaphores_for_execute.size(); i++) {
  1873. VkSemaphore wait_semaphore = command_queue->image_semaphores[command_queue->pending_semaphores_for_execute[i]];
  1874. wait_semaphores.push_back(wait_semaphore);
  1875. wait_semaphores_stages.push_back(VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT);
  1876. }
  1877. command_queue->pending_semaphores_for_execute.clear();
  1878. }
  1879. for (uint32_t i = 0; i < p_wait_semaphores.size(); i++) {
  1880. // FIXME: Allow specifying the stage mask in more detail.
  1881. wait_semaphores.push_back(VkSemaphore(p_wait_semaphores[i].id));
  1882. wait_semaphores_stages.push_back(VK_PIPELINE_STAGE_ALL_COMMANDS_BIT);
  1883. }
  1884. if (p_cmd_buffers.size() > 0) {
  1885. thread_local LocalVector<VkCommandBuffer> command_buffers;
  1886. thread_local LocalVector<VkSemaphore> signal_semaphores;
  1887. command_buffers.clear();
  1888. signal_semaphores.clear();
  1889. for (uint32_t i = 0; i < p_cmd_buffers.size(); i++) {
  1890. command_buffers.push_back(VkCommandBuffer(p_cmd_buffers[i].id));
  1891. }
  1892. for (uint32_t i = 0; i < p_cmd_semaphores.size(); i++) {
  1893. signal_semaphores.push_back(VkSemaphore(p_cmd_semaphores[i].id));
  1894. }
  1895. VkSemaphore present_semaphore = VK_NULL_HANDLE;
  1896. if (p_swap_chains.size() > 0) {
  1897. if (command_queue->present_semaphores.is_empty()) {
  1898. // Create the semaphores used for presentation if they haven't been created yet.
  1899. VkSemaphore semaphore = VK_NULL_HANDLE;
  1900. VkSemaphoreCreateInfo create_info = {};
  1901. create_info.sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO;
  1902. for (uint32_t i = 0; i < frame_count; i++) {
  1903. err = vkCreateSemaphore(vk_device, &create_info, nullptr, &semaphore);
  1904. ERR_FAIL_COND_V(err != VK_SUCCESS, FAILED);
  1905. command_queue->present_semaphores.push_back(semaphore);
  1906. }
  1907. }
  1908. // If a presentation semaphore is required, cycle across the ones available on the queue. It is technically possible
  1909. // and valid to reuse the same semaphore for this particular operation, but we create multiple ones anyway in case
  1910. // some hardware expects multiple semaphores to be used.
  1911. present_semaphore = command_queue->present_semaphores[command_queue->present_semaphore_index];
  1912. signal_semaphores.push_back(present_semaphore);
  1913. command_queue->present_semaphore_index = (command_queue->present_semaphore_index + 1) % command_queue->present_semaphores.size();
  1914. }
  1915. VkSubmitInfo submit_info = {};
  1916. submit_info.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
  1917. submit_info.waitSemaphoreCount = wait_semaphores.size();
  1918. submit_info.pWaitSemaphores = wait_semaphores.ptr();
  1919. submit_info.pWaitDstStageMask = wait_semaphores_stages.ptr();
  1920. submit_info.commandBufferCount = command_buffers.size();
  1921. submit_info.pCommandBuffers = command_buffers.ptr();
  1922. submit_info.signalSemaphoreCount = signal_semaphores.size();
  1923. submit_info.pSignalSemaphores = signal_semaphores.ptr();
  1924. device_queue.submit_mutex.lock();
  1925. err = vkQueueSubmit(device_queue.queue, 1, &submit_info, vk_fence);
  1926. device_queue.submit_mutex.unlock();
  1927. ERR_FAIL_COND_V(err != VK_SUCCESS, FAILED);
  1928. if (fence != nullptr && !command_queue->pending_semaphores_for_fence.is_empty()) {
  1929. fence->queue_signaled_from = command_queue;
  1930. // Indicate to the fence that it should release the semaphores that were waited on this submission the next time the fence is waited on.
  1931. for (uint32_t i = 0; i < command_queue->pending_semaphores_for_fence.size(); i++) {
  1932. command_queue->image_semaphores_for_fences.push_back({ fence, command_queue->pending_semaphores_for_fence[i] });
  1933. }
  1934. command_queue->pending_semaphores_for_fence.clear();
  1935. }
  1936. if (present_semaphore != VK_NULL_HANDLE) {
  1937. // If command buffers were executed, swap chains must wait on the present semaphore used by the command queue.
  1938. wait_semaphores.clear();
  1939. wait_semaphores.push_back(present_semaphore);
  1940. }
  1941. }
  1942. if (p_swap_chains.size() > 0) {
  1943. thread_local LocalVector<VkSwapchainKHR> swapchains;
  1944. thread_local LocalVector<uint32_t> image_indices;
  1945. thread_local LocalVector<VkResult> results;
  1946. swapchains.clear();
  1947. image_indices.clear();
  1948. for (uint32_t i = 0; i < p_swap_chains.size(); i++) {
  1949. SwapChain *swap_chain = (SwapChain *)(p_swap_chains[i].id);
  1950. swapchains.push_back(swap_chain->vk_swapchain);
  1951. DEV_ASSERT(swap_chain->image_index < swap_chain->images.size());
  1952. image_indices.push_back(swap_chain->image_index);
  1953. }
  1954. results.resize(swapchains.size());
  1955. VkPresentInfoKHR present_info = {};
  1956. present_info.sType = VK_STRUCTURE_TYPE_PRESENT_INFO_KHR;
  1957. present_info.waitSemaphoreCount = wait_semaphores.size();
  1958. present_info.pWaitSemaphores = wait_semaphores.ptr();
  1959. present_info.swapchainCount = swapchains.size();
  1960. present_info.pSwapchains = swapchains.ptr();
  1961. present_info.pImageIndices = image_indices.ptr();
  1962. present_info.pResults = results.ptr();
  1963. device_queue.submit_mutex.lock();
  1964. err = device_functions.QueuePresentKHR(device_queue.queue, &present_info);
  1965. device_queue.submit_mutex.unlock();
  1966. // Set the index to an invalid value. If any of the swap chains returned out of date, indicate it should be resized the next time it's acquired.
  1967. bool any_result_is_out_of_date = false;
  1968. for (uint32_t i = 0; i < p_swap_chains.size(); i++) {
  1969. SwapChain *swap_chain = (SwapChain *)(p_swap_chains[i].id);
  1970. swap_chain->image_index = UINT_MAX;
  1971. if (results[i] == VK_ERROR_OUT_OF_DATE_KHR) {
  1972. context_driver->surface_set_needs_resize(swap_chain->surface, true);
  1973. any_result_is_out_of_date = true;
  1974. }
  1975. }
  1976. if (any_result_is_out_of_date || err == VK_ERROR_OUT_OF_DATE_KHR) {
  1977. // It is possible for presentation to fail with out of date while acquire might've succeeded previously. This case
  1978. // will be considered a silent failure as it can be triggered easily by resizing a window in the OS natively.
  1979. return FAILED;
  1980. }
  1981. // Handling VK_SUBOPTIMAL_KHR the same as VK_SUCCESS is completely intentional.
  1982. //
  1983. // Godot does not currently support native rotation in Android when creating the swap chain. It intentionally uses
  1984. // VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR instead of the current transform bits available in the surface capabilities.
  1985. // Choosing the transform that leads to optimal presentation leads to distortion that makes the application unusable,
  1986. // as the rotation of all the content is not handled at the moment.
  1987. //
  1988. // VK_SUBOPTIMAL_KHR is accepted as a successful case even if it's not the most efficient solution to work around this
  1989. // problem. This behavior should not be changed unless the swap chain recreation uses the current transform bits, as
  1990. // it'll lead to very low performance in Android by entering an endless loop where it'll always resize the swap chain
  1991. // every frame.
  1992. ERR_FAIL_COND_V(err != VK_SUCCESS && err != VK_SUBOPTIMAL_KHR, FAILED);
  1993. }
  1994. return OK;
  1995. }
  1996. void RenderingDeviceDriverVulkan::command_queue_free(CommandQueueID p_cmd_queue) {
  1997. DEV_ASSERT(p_cmd_queue);
  1998. CommandQueue *command_queue = (CommandQueue *)(p_cmd_queue.id);
  1999. // Erase all the semaphores used for presentation.
  2000. for (VkSemaphore semaphore : command_queue->present_semaphores) {
  2001. vkDestroySemaphore(vk_device, semaphore, nullptr);
  2002. }
  2003. // Erase all the semaphores used for image acquisition.
  2004. for (VkSemaphore semaphore : command_queue->image_semaphores) {
  2005. vkDestroySemaphore(vk_device, semaphore, nullptr);
  2006. }
  2007. // Retrieve the queue family corresponding to the virtual queue.
  2008. DEV_ASSERT(command_queue->queue_family < queue_families.size());
  2009. TightLocalVector<Queue> &queue_family = queue_families[command_queue->queue_family];
  2010. // Decrease the virtual queue count.
  2011. DEV_ASSERT(command_queue->queue_index < queue_family.size());
  2012. DEV_ASSERT(queue_family[command_queue->queue_index].virtual_count > 0);
  2013. queue_family[command_queue->queue_index].virtual_count--;
  2014. // Destroy the virtual queue structure.
  2015. memdelete(command_queue);
  2016. }
  2017. // ----- POOL -----
  2018. RDD::CommandPoolID RenderingDeviceDriverVulkan::command_pool_create(CommandQueueFamilyID p_cmd_queue_family, CommandBufferType p_cmd_buffer_type) {
  2019. DEV_ASSERT(p_cmd_queue_family.id != 0);
  2020. uint32_t family_index = p_cmd_queue_family.id - 1;
  2021. VkCommandPoolCreateInfo cmd_pool_info = {};
  2022. cmd_pool_info.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
  2023. cmd_pool_info.queueFamilyIndex = family_index;
  2024. cmd_pool_info.flags = VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT;
  2025. VkCommandPool vk_command_pool = VK_NULL_HANDLE;
  2026. VkResult res = vkCreateCommandPool(vk_device, &cmd_pool_info, nullptr, &vk_command_pool);
  2027. ERR_FAIL_COND_V_MSG(res, CommandPoolID(), "vkCreateCommandPool failed with error " + itos(res) + ".");
  2028. CommandPool *command_pool = memnew(CommandPool);
  2029. command_pool->vk_command_pool = vk_command_pool;
  2030. command_pool->buffer_type = p_cmd_buffer_type;
  2031. return CommandPoolID(command_pool);
  2032. }
  2033. void RenderingDeviceDriverVulkan::command_pool_free(CommandPoolID p_cmd_pool) {
  2034. DEV_ASSERT(p_cmd_pool);
  2035. CommandPool *command_pool = (CommandPool *)(p_cmd_pool.id);
  2036. vkDestroyCommandPool(vk_device, command_pool->vk_command_pool, nullptr);
  2037. memdelete(command_pool);
  2038. }
  2039. // ----- BUFFER -----
  2040. RDD::CommandBufferID RenderingDeviceDriverVulkan::command_buffer_create(CommandPoolID p_cmd_pool) {
  2041. DEV_ASSERT(p_cmd_pool);
  2042. const CommandPool *command_pool = (const CommandPool *)(p_cmd_pool.id);
  2043. VkCommandBufferAllocateInfo cmd_buf_info = {};
  2044. cmd_buf_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
  2045. cmd_buf_info.commandPool = command_pool->vk_command_pool;
  2046. cmd_buf_info.commandBufferCount = 1;
  2047. if (command_pool->buffer_type == COMMAND_BUFFER_TYPE_SECONDARY) {
  2048. cmd_buf_info.level = VK_COMMAND_BUFFER_LEVEL_SECONDARY;
  2049. } else {
  2050. cmd_buf_info.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
  2051. }
  2052. VkCommandBuffer vk_cmd_buffer = VK_NULL_HANDLE;
  2053. VkResult err = vkAllocateCommandBuffers(vk_device, &cmd_buf_info, &vk_cmd_buffer);
  2054. ERR_FAIL_COND_V_MSG(err, CommandBufferID(), "vkAllocateCommandBuffers failed with error " + itos(err) + ".");
  2055. return CommandBufferID(vk_cmd_buffer);
  2056. }
  2057. bool RenderingDeviceDriverVulkan::command_buffer_begin(CommandBufferID p_cmd_buffer) {
  2058. // Reset is implicit (VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT).
  2059. VkCommandBufferBeginInfo cmd_buf_begin_info = {};
  2060. cmd_buf_begin_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
  2061. cmd_buf_begin_info.flags = VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT;
  2062. VkResult err = vkBeginCommandBuffer((VkCommandBuffer)p_cmd_buffer.id, &cmd_buf_begin_info);
  2063. ERR_FAIL_COND_V_MSG(err, false, "vkBeginCommandBuffer failed with error " + itos(err) + ".");
  2064. return true;
  2065. }
  2066. bool RenderingDeviceDriverVulkan::command_buffer_begin_secondary(CommandBufferID p_cmd_buffer, RenderPassID p_render_pass, uint32_t p_subpass, FramebufferID p_framebuffer) {
  2067. // Reset is implicit (VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT).
  2068. VkCommandBufferInheritanceInfo inheritance_info = {};
  2069. inheritance_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_INHERITANCE_INFO;
  2070. inheritance_info.renderPass = (VkRenderPass)p_render_pass.id;
  2071. inheritance_info.subpass = p_subpass;
  2072. inheritance_info.framebuffer = (VkFramebuffer)p_framebuffer.id;
  2073. VkCommandBufferBeginInfo cmd_buf_begin_info = {};
  2074. cmd_buf_begin_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
  2075. cmd_buf_begin_info.flags = VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT | VK_COMMAND_BUFFER_USAGE_RENDER_PASS_CONTINUE_BIT;
  2076. cmd_buf_begin_info.pInheritanceInfo = &inheritance_info;
  2077. VkResult err = vkBeginCommandBuffer((VkCommandBuffer)p_cmd_buffer.id, &cmd_buf_begin_info);
  2078. ERR_FAIL_COND_V_MSG(err, false, "vkBeginCommandBuffer failed with error " + itos(err) + ".");
  2079. return true;
  2080. }
  2081. void RenderingDeviceDriverVulkan::command_buffer_end(CommandBufferID p_cmd_buffer) {
  2082. vkEndCommandBuffer((VkCommandBuffer)p_cmd_buffer.id);
  2083. }
  2084. void RenderingDeviceDriverVulkan::command_buffer_execute_secondary(CommandBufferID p_cmd_buffer, VectorView<CommandBufferID> p_secondary_cmd_buffers) {
  2085. vkCmdExecuteCommands((VkCommandBuffer)p_cmd_buffer.id, p_secondary_cmd_buffers.size(), (const VkCommandBuffer *)p_secondary_cmd_buffers.ptr());
  2086. }
  2087. /********************/
  2088. /**** SWAP CHAIN ****/
  2089. /********************/
  2090. void RenderingDeviceDriverVulkan::_swap_chain_release(SwapChain *swap_chain) {
  2091. // Destroy views and framebuffers associated to the swapchain's images.
  2092. for (FramebufferID framebuffer : swap_chain->framebuffers) {
  2093. framebuffer_free(framebuffer);
  2094. }
  2095. for (VkImageView view : swap_chain->image_views) {
  2096. vkDestroyImageView(vk_device, view, nullptr);
  2097. }
  2098. swap_chain->image_index = UINT_MAX;
  2099. swap_chain->images.clear();
  2100. swap_chain->image_views.clear();
  2101. swap_chain->framebuffers.clear();
  2102. if (swap_chain->vk_swapchain != VK_NULL_HANDLE) {
  2103. device_functions.DestroySwapchainKHR(vk_device, swap_chain->vk_swapchain, nullptr);
  2104. swap_chain->vk_swapchain = VK_NULL_HANDLE;
  2105. }
  2106. for (uint32_t i = 0; i < swap_chain->command_queues_acquired.size(); i++) {
  2107. _recreate_image_semaphore(swap_chain->command_queues_acquired[i], swap_chain->command_queues_acquired_semaphores[i], false);
  2108. }
  2109. swap_chain->command_queues_acquired.clear();
  2110. swap_chain->command_queues_acquired_semaphores.clear();
  2111. }
  2112. RenderingDeviceDriver::SwapChainID RenderingDeviceDriverVulkan::swap_chain_create(RenderingContextDriver::SurfaceID p_surface) {
  2113. DEV_ASSERT(p_surface != 0);
  2114. RenderingContextDriverVulkan::Surface *surface = (RenderingContextDriverVulkan::Surface *)(p_surface);
  2115. const RenderingContextDriverVulkan::Functions &functions = context_driver->functions_get();
  2116. // Retrieve the formats supported by the surface.
  2117. uint32_t format_count = 0;
  2118. VkResult err = functions.GetPhysicalDeviceSurfaceFormatsKHR(physical_device, surface->vk_surface, &format_count, nullptr);
  2119. ERR_FAIL_COND_V(err != VK_SUCCESS, SwapChainID());
  2120. TightLocalVector<VkSurfaceFormatKHR> formats;
  2121. formats.resize(format_count);
  2122. err = functions.GetPhysicalDeviceSurfaceFormatsKHR(physical_device, surface->vk_surface, &format_count, formats.ptr());
  2123. ERR_FAIL_COND_V(err != VK_SUCCESS, SwapChainID());
  2124. VkFormat format = VK_FORMAT_UNDEFINED;
  2125. VkColorSpaceKHR color_space = VK_COLOR_SPACE_SRGB_NONLINEAR_KHR;
  2126. if (format_count == 1 && formats[0].format == VK_FORMAT_UNDEFINED) {
  2127. // If the format list includes just one entry of VK_FORMAT_UNDEFINED, the surface has no preferred format.
  2128. format = VK_FORMAT_B8G8R8A8_UNORM;
  2129. color_space = formats[0].colorSpace;
  2130. } else if (format_count > 0) {
  2131. // Use one of the supported formats, prefer B8G8R8A8_UNORM.
  2132. const VkFormat preferred_format = VK_FORMAT_B8G8R8A8_UNORM;
  2133. const VkFormat second_format = VK_FORMAT_R8G8B8A8_UNORM;
  2134. for (uint32_t i = 0; i < format_count; i++) {
  2135. if (formats[i].format == preferred_format || formats[i].format == second_format) {
  2136. format = formats[i].format;
  2137. if (formats[i].format == preferred_format) {
  2138. // This is the preferred format, stop searching.
  2139. break;
  2140. }
  2141. }
  2142. }
  2143. }
  2144. // No formats are supported.
  2145. ERR_FAIL_COND_V_MSG(format == VK_FORMAT_UNDEFINED, SwapChainID(), "Surface did not return any valid formats.");
  2146. // Create the render pass for the chosen format.
  2147. VkAttachmentDescription2KHR attachment = {};
  2148. attachment.sType = VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2_KHR;
  2149. attachment.format = format;
  2150. attachment.samples = VK_SAMPLE_COUNT_1_BIT;
  2151. attachment.loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR;
  2152. attachment.storeOp = VK_ATTACHMENT_STORE_OP_STORE;
  2153. attachment.stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
  2154. attachment.stencilStoreOp = VK_ATTACHMENT_STORE_OP_DONT_CARE;
  2155. attachment.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  2156. attachment.finalLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
  2157. VkAttachmentReference2KHR color_reference = {};
  2158. color_reference.sType = VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2_KHR;
  2159. color_reference.layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
  2160. VkSubpassDescription2KHR subpass = {};
  2161. subpass.sType = VK_STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2_KHR;
  2162. subpass.pipelineBindPoint = VK_PIPELINE_BIND_POINT_GRAPHICS;
  2163. subpass.colorAttachmentCount = 1;
  2164. subpass.pColorAttachments = &color_reference;
  2165. VkRenderPassCreateInfo2KHR pass_info = {};
  2166. pass_info.sType = VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO_2_KHR;
  2167. pass_info.attachmentCount = 1;
  2168. pass_info.pAttachments = &attachment;
  2169. pass_info.subpassCount = 1;
  2170. pass_info.pSubpasses = &subpass;
  2171. VkRenderPass render_pass = VK_NULL_HANDLE;
  2172. err = _create_render_pass(vk_device, &pass_info, nullptr, &render_pass);
  2173. ERR_FAIL_COND_V(err != VK_SUCCESS, SwapChainID());
  2174. SwapChain *swap_chain = memnew(SwapChain);
  2175. swap_chain->surface = p_surface;
  2176. swap_chain->format = format;
  2177. swap_chain->color_space = color_space;
  2178. swap_chain->render_pass = RenderPassID(render_pass);
  2179. return SwapChainID(swap_chain);
  2180. }
  2181. Error RenderingDeviceDriverVulkan::swap_chain_resize(CommandQueueID p_cmd_queue, SwapChainID p_swap_chain, uint32_t p_desired_framebuffer_count) {
  2182. DEV_ASSERT(p_cmd_queue.id != 0);
  2183. DEV_ASSERT(p_swap_chain.id != 0);
  2184. CommandQueue *command_queue = (CommandQueue *)(p_cmd_queue.id);
  2185. SwapChain *swap_chain = (SwapChain *)(p_swap_chain.id);
  2186. // Release all current contents of the swap chain.
  2187. _swap_chain_release(swap_chain);
  2188. // Validate if the command queue being used supports creating the swap chain for this surface.
  2189. const RenderingContextDriverVulkan::Functions &functions = context_driver->functions_get();
  2190. if (!context_driver->queue_family_supports_present(physical_device, command_queue->queue_family, swap_chain->surface)) {
  2191. ERR_FAIL_V_MSG(ERR_CANT_CREATE, "Surface is not supported by device. Did the GPU go offline? Was the window created on another monitor? Check"
  2192. "previous errors & try launching with --gpu-validation.");
  2193. }
  2194. // Retrieve the surface's capabilities.
  2195. RenderingContextDriverVulkan::Surface *surface = (RenderingContextDriverVulkan::Surface *)(swap_chain->surface);
  2196. VkSurfaceCapabilitiesKHR surface_capabilities = {};
  2197. VkResult err = functions.GetPhysicalDeviceSurfaceCapabilitiesKHR(physical_device, surface->vk_surface, &surface_capabilities);
  2198. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  2199. VkExtent2D extent;
  2200. if (surface_capabilities.currentExtent.width == 0xFFFFFFFF) {
  2201. // The current extent is currently undefined, so the current surface width and height will be clamped to the surface's capabilities.
  2202. extent.width = CLAMP(surface->width, surface_capabilities.minImageExtent.width, surface_capabilities.maxImageExtent.width);
  2203. extent.height = CLAMP(surface->height, surface_capabilities.minImageExtent.height, surface_capabilities.maxImageExtent.height);
  2204. } else {
  2205. // Grab the dimensions from the current extent.
  2206. extent = surface_capabilities.currentExtent;
  2207. surface->width = extent.width;
  2208. surface->height = extent.height;
  2209. }
  2210. if (surface->width == 0 || surface->height == 0) {
  2211. // The surface doesn't have valid dimensions, so we can't create a swap chain.
  2212. return ERR_SKIP;
  2213. }
  2214. // Find what present modes are supported.
  2215. TightLocalVector<VkPresentModeKHR> present_modes;
  2216. uint32_t present_modes_count = 0;
  2217. err = functions.GetPhysicalDeviceSurfacePresentModesKHR(physical_device, surface->vk_surface, &present_modes_count, nullptr);
  2218. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  2219. present_modes.resize(present_modes_count);
  2220. err = functions.GetPhysicalDeviceSurfacePresentModesKHR(physical_device, surface->vk_surface, &present_modes_count, present_modes.ptr());
  2221. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  2222. // Choose the present mode based on the display server setting.
  2223. VkPresentModeKHR present_mode = VkPresentModeKHR::VK_PRESENT_MODE_FIFO_KHR;
  2224. String present_mode_name = "Enabled";
  2225. switch (surface->vsync_mode) {
  2226. case DisplayServer::VSYNC_MAILBOX:
  2227. present_mode = VK_PRESENT_MODE_MAILBOX_KHR;
  2228. present_mode_name = "Mailbox";
  2229. break;
  2230. case DisplayServer::VSYNC_ADAPTIVE:
  2231. present_mode = VK_PRESENT_MODE_FIFO_RELAXED_KHR;
  2232. present_mode_name = "Adaptive";
  2233. break;
  2234. case DisplayServer::VSYNC_ENABLED:
  2235. present_mode = VK_PRESENT_MODE_FIFO_KHR;
  2236. present_mode_name = "Enabled";
  2237. break;
  2238. case DisplayServer::VSYNC_DISABLED:
  2239. present_mode = VK_PRESENT_MODE_IMMEDIATE_KHR;
  2240. present_mode_name = "Disabled";
  2241. break;
  2242. }
  2243. bool present_mode_available = present_modes.find(present_mode) >= 0;
  2244. if (present_mode_available) {
  2245. print_verbose("Using present mode: " + present_mode_name);
  2246. } else {
  2247. // Present mode is not available, fall back to FIFO which is guaranteed to be supported.
  2248. WARN_PRINT(vformat("The requested V-Sync mode %s is not available. Falling back to V-Sync mode Enabled.", present_mode_name));
  2249. surface->vsync_mode = DisplayServer::VSYNC_ENABLED;
  2250. present_mode = VkPresentModeKHR::VK_PRESENT_MODE_FIFO_KHR;
  2251. }
  2252. // Clamp the desired image count to the surface's capabilities.
  2253. uint32_t desired_swapchain_images = MAX(p_desired_framebuffer_count, surface_capabilities.minImageCount);
  2254. if (surface_capabilities.maxImageCount > 0) {
  2255. // Only clamp to the max image count if it's defined. A max image count of 0 means there's no upper limit to the amount of images.
  2256. desired_swapchain_images = MIN(desired_swapchain_images, surface_capabilities.maxImageCount);
  2257. }
  2258. // Prefer identity transform if it's supported, use the current transform otherwise.
  2259. // This behavior is intended as Godot does not supported native rotation in platforms that use these bits.
  2260. // Refer to the comment in command_queue_present() for more details.
  2261. VkSurfaceTransformFlagBitsKHR surface_transform_bits;
  2262. if (surface_capabilities.supportedTransforms & VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR) {
  2263. surface_transform_bits = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
  2264. } else {
  2265. surface_transform_bits = surface_capabilities.currentTransform;
  2266. }
  2267. VkCompositeAlphaFlagBitsKHR composite_alpha = VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR;
  2268. if (OS::get_singleton()->is_layered_allowed() || !(surface_capabilities.supportedCompositeAlpha & composite_alpha)) {
  2269. // Find a supported composite alpha mode - one of these is guaranteed to be set.
  2270. VkCompositeAlphaFlagBitsKHR composite_alpha_flags[4] = {
  2271. VK_COMPOSITE_ALPHA_PRE_MULTIPLIED_BIT_KHR,
  2272. VK_COMPOSITE_ALPHA_POST_MULTIPLIED_BIT_KHR,
  2273. VK_COMPOSITE_ALPHA_INHERIT_BIT_KHR,
  2274. VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR
  2275. };
  2276. for (uint32_t i = 0; i < ARRAY_SIZE(composite_alpha_flags); i++) {
  2277. if (surface_capabilities.supportedCompositeAlpha & composite_alpha_flags[i]) {
  2278. composite_alpha = composite_alpha_flags[i];
  2279. break;
  2280. }
  2281. }
  2282. }
  2283. VkSwapchainCreateInfoKHR swap_create_info = {};
  2284. swap_create_info.sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR;
  2285. swap_create_info.surface = surface->vk_surface;
  2286. swap_create_info.minImageCount = desired_swapchain_images;
  2287. swap_create_info.imageFormat = swap_chain->format;
  2288. swap_create_info.imageColorSpace = swap_chain->color_space;
  2289. swap_create_info.imageExtent = extent;
  2290. swap_create_info.imageArrayLayers = 1;
  2291. swap_create_info.imageUsage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
  2292. swap_create_info.imageSharingMode = VK_SHARING_MODE_EXCLUSIVE;
  2293. swap_create_info.preTransform = surface_transform_bits;
  2294. swap_create_info.compositeAlpha = composite_alpha;
  2295. swap_create_info.presentMode = present_mode;
  2296. swap_create_info.clipped = true;
  2297. err = device_functions.CreateSwapchainKHR(vk_device, &swap_create_info, nullptr, &swap_chain->vk_swapchain);
  2298. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  2299. uint32_t image_count = 0;
  2300. err = device_functions.GetSwapchainImagesKHR(vk_device, swap_chain->vk_swapchain, &image_count, nullptr);
  2301. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  2302. swap_chain->images.resize(image_count);
  2303. err = device_functions.GetSwapchainImagesKHR(vk_device, swap_chain->vk_swapchain, &image_count, swap_chain->images.ptr());
  2304. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  2305. VkImageViewCreateInfo view_create_info = {};
  2306. view_create_info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
  2307. view_create_info.viewType = VK_IMAGE_VIEW_TYPE_2D;
  2308. view_create_info.format = swap_chain->format;
  2309. view_create_info.components.r = VK_COMPONENT_SWIZZLE_R;
  2310. view_create_info.components.g = VK_COMPONENT_SWIZZLE_G;
  2311. view_create_info.components.b = VK_COMPONENT_SWIZZLE_B;
  2312. view_create_info.components.a = VK_COMPONENT_SWIZZLE_A;
  2313. view_create_info.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  2314. view_create_info.subresourceRange.levelCount = 1;
  2315. view_create_info.subresourceRange.layerCount = 1;
  2316. swap_chain->image_views.reserve(image_count);
  2317. VkImageView image_view;
  2318. for (uint32_t i = 0; i < image_count; i++) {
  2319. view_create_info.image = swap_chain->images[i];
  2320. err = vkCreateImageView(vk_device, &view_create_info, nullptr, &image_view);
  2321. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  2322. swap_chain->image_views.push_back(image_view);
  2323. }
  2324. swap_chain->framebuffers.reserve(image_count);
  2325. VkFramebufferCreateInfo fb_create_info = {};
  2326. fb_create_info.sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO;
  2327. fb_create_info.renderPass = VkRenderPass(swap_chain->render_pass.id);
  2328. fb_create_info.attachmentCount = 1;
  2329. fb_create_info.width = surface->width;
  2330. fb_create_info.height = surface->height;
  2331. fb_create_info.layers = 1;
  2332. VkFramebuffer framebuffer;
  2333. for (uint32_t i = 0; i < image_count; i++) {
  2334. fb_create_info.pAttachments = &swap_chain->image_views[i];
  2335. err = vkCreateFramebuffer(vk_device, &fb_create_info, nullptr, &framebuffer);
  2336. ERR_FAIL_COND_V(err != VK_SUCCESS, ERR_CANT_CREATE);
  2337. swap_chain->framebuffers.push_back(RDD::FramebufferID(framebuffer));
  2338. }
  2339. // Once everything's been created correctly, indicate the surface no longer needs to be resized.
  2340. context_driver->surface_set_needs_resize(swap_chain->surface, false);
  2341. return OK;
  2342. }
  2343. RDD::FramebufferID RenderingDeviceDriverVulkan::swap_chain_acquire_framebuffer(CommandQueueID p_cmd_queue, SwapChainID p_swap_chain, bool &r_resize_required) {
  2344. DEV_ASSERT(p_cmd_queue);
  2345. DEV_ASSERT(p_swap_chain);
  2346. CommandQueue *command_queue = (CommandQueue *)(p_cmd_queue.id);
  2347. SwapChain *swap_chain = (SwapChain *)(p_swap_chain.id);
  2348. if ((swap_chain->vk_swapchain == VK_NULL_HANDLE) || context_driver->surface_get_needs_resize(swap_chain->surface)) {
  2349. // The surface does not have a valid swap chain or it indicates it requires a resize.
  2350. r_resize_required = true;
  2351. return FramebufferID();
  2352. }
  2353. VkResult err;
  2354. VkSemaphore semaphore = VK_NULL_HANDLE;
  2355. uint32_t semaphore_index = 0;
  2356. if (command_queue->free_image_semaphores.is_empty()) {
  2357. // Add a new semaphore if none are free.
  2358. VkSemaphoreCreateInfo create_info = {};
  2359. create_info.sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO;
  2360. err = vkCreateSemaphore(vk_device, &create_info, nullptr, &semaphore);
  2361. ERR_FAIL_COND_V(err != VK_SUCCESS, FramebufferID());
  2362. semaphore_index = command_queue->image_semaphores.size();
  2363. command_queue->image_semaphores.push_back(semaphore);
  2364. command_queue->image_semaphores_swap_chains.push_back(swap_chain);
  2365. } else {
  2366. // Pick a free semaphore.
  2367. uint32_t free_index = command_queue->free_image_semaphores.size() - 1;
  2368. semaphore_index = command_queue->free_image_semaphores[free_index];
  2369. command_queue->image_semaphores_swap_chains[semaphore_index] = swap_chain;
  2370. command_queue->free_image_semaphores.remove_at(free_index);
  2371. semaphore = command_queue->image_semaphores[semaphore_index];
  2372. }
  2373. // Store in the swap chain the acquired semaphore.
  2374. swap_chain->command_queues_acquired.push_back(command_queue);
  2375. swap_chain->command_queues_acquired_semaphores.push_back(semaphore_index);
  2376. err = device_functions.AcquireNextImageKHR(vk_device, swap_chain->vk_swapchain, UINT64_MAX, semaphore, VK_NULL_HANDLE, &swap_chain->image_index);
  2377. if (err == VK_ERROR_OUT_OF_DATE_KHR) {
  2378. // Out of date leaves the semaphore in a signaled state that will never finish, so it's necessary to recreate it.
  2379. bool semaphore_recreated = _recreate_image_semaphore(command_queue, semaphore_index, true);
  2380. ERR_FAIL_COND_V(!semaphore_recreated, FramebufferID());
  2381. // Swap chain is out of date and must be recreated.
  2382. r_resize_required = true;
  2383. return FramebufferID();
  2384. } else if (err != VK_SUCCESS && err != VK_SUBOPTIMAL_KHR) {
  2385. // Swap chain failed to present but the reason is unknown.
  2386. // Refer to the comment in command_queue_present() as to why VK_SUBOPTIMAL_KHR is handled the same as VK_SUCCESS.
  2387. return FramebufferID();
  2388. }
  2389. // Indicate the command queue should wait on these semaphores on the next submission and that it should
  2390. // indicate they're free again on the next fence.
  2391. command_queue->pending_semaphores_for_execute.push_back(semaphore_index);
  2392. command_queue->pending_semaphores_for_fence.push_back(semaphore_index);
  2393. // Return the corresponding framebuffer to the new current image.
  2394. return swap_chain->framebuffers[swap_chain->image_index];
  2395. }
  2396. RDD::RenderPassID RenderingDeviceDriverVulkan::swap_chain_get_render_pass(SwapChainID p_swap_chain) {
  2397. DEV_ASSERT(p_swap_chain.id != 0);
  2398. SwapChain *swap_chain = (SwapChain *)(p_swap_chain.id);
  2399. return swap_chain->render_pass;
  2400. }
  2401. RDD::DataFormat RenderingDeviceDriverVulkan::swap_chain_get_format(SwapChainID p_swap_chain) {
  2402. DEV_ASSERT(p_swap_chain.id != 0);
  2403. SwapChain *swap_chain = (SwapChain *)(p_swap_chain.id);
  2404. switch (swap_chain->format) {
  2405. case VK_FORMAT_B8G8R8A8_UNORM:
  2406. return DATA_FORMAT_B8G8R8A8_UNORM;
  2407. case VK_FORMAT_R8G8B8A8_UNORM:
  2408. return DATA_FORMAT_R8G8B8A8_UNORM;
  2409. default:
  2410. DEV_ASSERT(false && "Unknown swap chain format.");
  2411. return DATA_FORMAT_MAX;
  2412. }
  2413. }
  2414. void RenderingDeviceDriverVulkan::swap_chain_free(SwapChainID p_swap_chain) {
  2415. DEV_ASSERT(p_swap_chain.id != 0);
  2416. SwapChain *swap_chain = (SwapChain *)(p_swap_chain.id);
  2417. _swap_chain_release(swap_chain);
  2418. if (swap_chain->render_pass.id != 0) {
  2419. vkDestroyRenderPass(vk_device, VkRenderPass(swap_chain->render_pass.id), nullptr);
  2420. }
  2421. memdelete(swap_chain);
  2422. }
  2423. /*********************/
  2424. /**** FRAMEBUFFER ****/
  2425. /*********************/
  2426. RDD::FramebufferID RenderingDeviceDriverVulkan::framebuffer_create(RenderPassID p_render_pass, VectorView<TextureID> p_attachments, uint32_t p_width, uint32_t p_height) {
  2427. VkImageView *vk_img_views = ALLOCA_ARRAY(VkImageView, p_attachments.size());
  2428. for (uint32_t i = 0; i < p_attachments.size(); i++) {
  2429. vk_img_views[i] = ((const TextureInfo *)p_attachments[i].id)->vk_view;
  2430. }
  2431. VkFramebufferCreateInfo framebuffer_create_info = {};
  2432. framebuffer_create_info.sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO;
  2433. framebuffer_create_info.renderPass = (VkRenderPass)p_render_pass.id;
  2434. framebuffer_create_info.attachmentCount = p_attachments.size();
  2435. framebuffer_create_info.pAttachments = vk_img_views;
  2436. framebuffer_create_info.width = p_width;
  2437. framebuffer_create_info.height = p_height;
  2438. framebuffer_create_info.layers = 1;
  2439. VkFramebuffer vk_framebuffer = VK_NULL_HANDLE;
  2440. VkResult err = vkCreateFramebuffer(vk_device, &framebuffer_create_info, nullptr, &vk_framebuffer);
  2441. ERR_FAIL_COND_V_MSG(err, FramebufferID(), "vkCreateFramebuffer failed with error " + itos(err) + ".");
  2442. #if PRINT_NATIVE_COMMANDS
  2443. print_line(vformat("vkCreateFramebuffer 0x%uX with %d attachments", uint64_t(vk_framebuffer), p_attachments.size()));
  2444. for (uint32_t i = 0; i < p_attachments.size(); i++) {
  2445. const TextureInfo *attachment_info = (const TextureInfo *)p_attachments[i].id;
  2446. print_line(vformat(" Attachment #%d: IMAGE 0x%uX VIEW 0x%uX", i, uint64_t(attachment_info->vk_view_create_info.image), uint64_t(attachment_info->vk_view)));
  2447. }
  2448. #endif
  2449. return FramebufferID(vk_framebuffer);
  2450. }
  2451. void RenderingDeviceDriverVulkan::framebuffer_free(FramebufferID p_framebuffer) {
  2452. vkDestroyFramebuffer(vk_device, (VkFramebuffer)p_framebuffer.id, nullptr);
  2453. }
  2454. /****************/
  2455. /**** SHADER ****/
  2456. /****************/
  2457. static VkShaderStageFlagBits RD_STAGE_TO_VK_SHADER_STAGE_BITS[RDD::SHADER_STAGE_MAX] = {
  2458. VK_SHADER_STAGE_VERTEX_BIT,
  2459. VK_SHADER_STAGE_FRAGMENT_BIT,
  2460. VK_SHADER_STAGE_TESSELLATION_CONTROL_BIT,
  2461. VK_SHADER_STAGE_TESSELLATION_EVALUATION_BIT,
  2462. VK_SHADER_STAGE_COMPUTE_BIT,
  2463. };
  2464. String RenderingDeviceDriverVulkan::shader_get_binary_cache_key() {
  2465. return "Vulkan-SV" + uitos(ShaderBinary::VERSION);
  2466. }
  2467. Vector<uint8_t> RenderingDeviceDriverVulkan::shader_compile_binary_from_spirv(VectorView<ShaderStageSPIRVData> p_spirv, const String &p_shader_name) {
  2468. ShaderReflection shader_refl;
  2469. if (_reflect_spirv(p_spirv, shader_refl) != OK) {
  2470. return Vector<uint8_t>();
  2471. }
  2472. ERR_FAIL_COND_V_MSG((uint32_t)shader_refl.uniform_sets.size() > physical_device_properties.limits.maxBoundDescriptorSets, Vector<uint8_t>(),
  2473. "Number of uniform sets is larger than what is supported by the hardware (" + itos(physical_device_properties.limits.maxBoundDescriptorSets) + ").");
  2474. // Collect reflection data into binary data.
  2475. ShaderBinary::Data binary_data;
  2476. Vector<Vector<ShaderBinary::DataBinding>> uniforms; // Set bindings.
  2477. Vector<ShaderBinary::SpecializationConstant> specialization_constants;
  2478. {
  2479. binary_data.vertex_input_mask = shader_refl.vertex_input_mask;
  2480. binary_data.fragment_output_mask = shader_refl.fragment_output_mask;
  2481. binary_data.specialization_constants_count = shader_refl.specialization_constants.size();
  2482. binary_data.is_compute = shader_refl.is_compute;
  2483. binary_data.compute_local_size[0] = shader_refl.compute_local_size[0];
  2484. binary_data.compute_local_size[1] = shader_refl.compute_local_size[1];
  2485. binary_data.compute_local_size[2] = shader_refl.compute_local_size[2];
  2486. binary_data.set_count = shader_refl.uniform_sets.size();
  2487. binary_data.push_constant_size = shader_refl.push_constant_size;
  2488. for (uint32_t i = 0; i < SHADER_STAGE_MAX; i++) {
  2489. if (shader_refl.push_constant_stages.has_flag((ShaderStage)(1 << i))) {
  2490. binary_data.vk_push_constant_stages_mask |= RD_STAGE_TO_VK_SHADER_STAGE_BITS[i];
  2491. }
  2492. }
  2493. for (const Vector<ShaderUniform> &set_refl : shader_refl.uniform_sets) {
  2494. Vector<ShaderBinary::DataBinding> set_bindings;
  2495. for (const ShaderUniform &uniform_refl : set_refl) {
  2496. ShaderBinary::DataBinding binding;
  2497. binding.type = (uint32_t)uniform_refl.type;
  2498. binding.binding = uniform_refl.binding;
  2499. binding.stages = (uint32_t)uniform_refl.stages;
  2500. binding.length = uniform_refl.length;
  2501. binding.writable = (uint32_t)uniform_refl.writable;
  2502. set_bindings.push_back(binding);
  2503. }
  2504. uniforms.push_back(set_bindings);
  2505. }
  2506. for (const ShaderSpecializationConstant &refl_sc : shader_refl.specialization_constants) {
  2507. ShaderBinary::SpecializationConstant spec_constant;
  2508. spec_constant.type = (uint32_t)refl_sc.type;
  2509. spec_constant.constant_id = refl_sc.constant_id;
  2510. spec_constant.int_value = refl_sc.int_value;
  2511. spec_constant.stage_flags = (uint32_t)refl_sc.stages;
  2512. specialization_constants.push_back(spec_constant);
  2513. }
  2514. }
  2515. Vector<Vector<uint8_t>> compressed_stages;
  2516. Vector<uint32_t> smolv_size;
  2517. Vector<uint32_t> zstd_size; // If 0, zstd not used.
  2518. uint32_t stages_binary_size = 0;
  2519. bool strip_debug = false;
  2520. for (uint32_t i = 0; i < p_spirv.size(); i++) {
  2521. smolv::ByteArray smolv;
  2522. if (!smolv::Encode(p_spirv[i].spirv.ptr(), p_spirv[i].spirv.size(), smolv, strip_debug ? smolv::kEncodeFlagStripDebugInfo : 0)) {
  2523. ERR_FAIL_V_MSG(Vector<uint8_t>(), "Error compressing shader stage :" + String(SHADER_STAGE_NAMES[p_spirv[i].shader_stage]));
  2524. } else {
  2525. smolv_size.push_back(smolv.size());
  2526. { // zstd.
  2527. Vector<uint8_t> zstd;
  2528. zstd.resize(Compression::get_max_compressed_buffer_size(smolv.size(), Compression::MODE_ZSTD));
  2529. int dst_size = Compression::compress(zstd.ptrw(), &smolv[0], smolv.size(), Compression::MODE_ZSTD);
  2530. if (dst_size > 0 && (uint32_t)dst_size < smolv.size()) {
  2531. zstd_size.push_back(dst_size);
  2532. zstd.resize(dst_size);
  2533. compressed_stages.push_back(zstd);
  2534. } else {
  2535. Vector<uint8_t> smv;
  2536. smv.resize(smolv.size());
  2537. memcpy(smv.ptrw(), &smolv[0], smolv.size());
  2538. zstd_size.push_back(0); // Not using zstd.
  2539. compressed_stages.push_back(smv);
  2540. }
  2541. }
  2542. }
  2543. uint32_t s = compressed_stages[i].size();
  2544. stages_binary_size += STEPIFY(s, 4);
  2545. }
  2546. binary_data.specialization_constants_count = specialization_constants.size();
  2547. binary_data.set_count = uniforms.size();
  2548. binary_data.stage_count = p_spirv.size();
  2549. CharString shader_name_utf = p_shader_name.utf8();
  2550. binary_data.shader_name_len = shader_name_utf.length();
  2551. uint32_t total_size = sizeof(uint32_t) * 3; // Header + version + main datasize;.
  2552. total_size += sizeof(ShaderBinary::Data);
  2553. total_size += STEPIFY(binary_data.shader_name_len, 4);
  2554. for (int i = 0; i < uniforms.size(); i++) {
  2555. total_size += sizeof(uint32_t);
  2556. total_size += uniforms[i].size() * sizeof(ShaderBinary::DataBinding);
  2557. }
  2558. total_size += sizeof(ShaderBinary::SpecializationConstant) * specialization_constants.size();
  2559. total_size += compressed_stages.size() * sizeof(uint32_t) * 3; // Sizes.
  2560. total_size += stages_binary_size;
  2561. Vector<uint8_t> ret;
  2562. ret.resize(total_size);
  2563. {
  2564. uint32_t offset = 0;
  2565. uint8_t *binptr = ret.ptrw();
  2566. binptr[0] = 'G';
  2567. binptr[1] = 'S';
  2568. binptr[2] = 'B';
  2569. binptr[3] = 'D'; // Godot Shader Binary Data.
  2570. offset += 4;
  2571. encode_uint32(ShaderBinary::VERSION, binptr + offset);
  2572. offset += sizeof(uint32_t);
  2573. encode_uint32(sizeof(ShaderBinary::Data), binptr + offset);
  2574. offset += sizeof(uint32_t);
  2575. memcpy(binptr + offset, &binary_data, sizeof(ShaderBinary::Data));
  2576. offset += sizeof(ShaderBinary::Data);
  2577. #define ADVANCE_OFFSET_WITH_ALIGNMENT(m_bytes) \
  2578. { \
  2579. offset += m_bytes; \
  2580. uint32_t padding = STEPIFY(m_bytes, 4) - m_bytes; \
  2581. memset(binptr + offset, 0, padding); /* Avoid garbage data. */ \
  2582. offset += padding; \
  2583. }
  2584. if (binary_data.shader_name_len > 0) {
  2585. memcpy(binptr + offset, shader_name_utf.ptr(), binary_data.shader_name_len);
  2586. ADVANCE_OFFSET_WITH_ALIGNMENT(binary_data.shader_name_len);
  2587. }
  2588. for (int i = 0; i < uniforms.size(); i++) {
  2589. int count = uniforms[i].size();
  2590. encode_uint32(count, binptr + offset);
  2591. offset += sizeof(uint32_t);
  2592. if (count > 0) {
  2593. memcpy(binptr + offset, uniforms[i].ptr(), sizeof(ShaderBinary::DataBinding) * count);
  2594. offset += sizeof(ShaderBinary::DataBinding) * count;
  2595. }
  2596. }
  2597. if (specialization_constants.size()) {
  2598. memcpy(binptr + offset, specialization_constants.ptr(), sizeof(ShaderBinary::SpecializationConstant) * specialization_constants.size());
  2599. offset += sizeof(ShaderBinary::SpecializationConstant) * specialization_constants.size();
  2600. }
  2601. for (int i = 0; i < compressed_stages.size(); i++) {
  2602. encode_uint32(p_spirv[i].shader_stage, binptr + offset);
  2603. offset += sizeof(uint32_t);
  2604. encode_uint32(smolv_size[i], binptr + offset);
  2605. offset += sizeof(uint32_t);
  2606. encode_uint32(zstd_size[i], binptr + offset);
  2607. offset += sizeof(uint32_t);
  2608. memcpy(binptr + offset, compressed_stages[i].ptr(), compressed_stages[i].size());
  2609. ADVANCE_OFFSET_WITH_ALIGNMENT(compressed_stages[i].size());
  2610. }
  2611. DEV_ASSERT(offset == (uint32_t)ret.size());
  2612. }
  2613. return ret;
  2614. }
  2615. RDD::ShaderID RenderingDeviceDriverVulkan::shader_create_from_bytecode(const Vector<uint8_t> &p_shader_binary, ShaderDescription &r_shader_desc, String &r_name) {
  2616. r_shader_desc = {}; // Driver-agnostic.
  2617. ShaderInfo shader_info; // Driver-specific.
  2618. const uint8_t *binptr = p_shader_binary.ptr();
  2619. uint32_t binsize = p_shader_binary.size();
  2620. uint32_t read_offset = 0;
  2621. // Consistency check.
  2622. ERR_FAIL_COND_V(binsize < sizeof(uint32_t) * 3 + sizeof(ShaderBinary::Data), ShaderID());
  2623. ERR_FAIL_COND_V(binptr[0] != 'G' || binptr[1] != 'S' || binptr[2] != 'B' || binptr[3] != 'D', ShaderID());
  2624. uint32_t bin_version = decode_uint32(binptr + 4);
  2625. ERR_FAIL_COND_V(bin_version != ShaderBinary::VERSION, ShaderID());
  2626. uint32_t bin_data_size = decode_uint32(binptr + 8);
  2627. const ShaderBinary::Data &binary_data = *(reinterpret_cast<const ShaderBinary::Data *>(binptr + 12));
  2628. r_shader_desc.push_constant_size = binary_data.push_constant_size;
  2629. shader_info.vk_push_constant_stages = binary_data.vk_push_constant_stages_mask;
  2630. r_shader_desc.vertex_input_mask = binary_data.vertex_input_mask;
  2631. r_shader_desc.fragment_output_mask = binary_data.fragment_output_mask;
  2632. r_shader_desc.is_compute = binary_data.is_compute;
  2633. r_shader_desc.compute_local_size[0] = binary_data.compute_local_size[0];
  2634. r_shader_desc.compute_local_size[1] = binary_data.compute_local_size[1];
  2635. r_shader_desc.compute_local_size[2] = binary_data.compute_local_size[2];
  2636. read_offset += sizeof(uint32_t) * 3 + bin_data_size;
  2637. if (binary_data.shader_name_len) {
  2638. r_name.parse_utf8((const char *)(binptr + read_offset), binary_data.shader_name_len);
  2639. read_offset += STEPIFY(binary_data.shader_name_len, 4);
  2640. }
  2641. Vector<Vector<VkDescriptorSetLayoutBinding>> vk_set_bindings;
  2642. r_shader_desc.uniform_sets.resize(binary_data.set_count);
  2643. vk_set_bindings.resize(binary_data.set_count);
  2644. for (uint32_t i = 0; i < binary_data.set_count; i++) {
  2645. ERR_FAIL_COND_V(read_offset + sizeof(uint32_t) >= binsize, ShaderID());
  2646. uint32_t set_count = decode_uint32(binptr + read_offset);
  2647. read_offset += sizeof(uint32_t);
  2648. const ShaderBinary::DataBinding *set_ptr = reinterpret_cast<const ShaderBinary::DataBinding *>(binptr + read_offset);
  2649. uint32_t set_size = set_count * sizeof(ShaderBinary::DataBinding);
  2650. ERR_FAIL_COND_V(read_offset + set_size >= binsize, ShaderID());
  2651. for (uint32_t j = 0; j < set_count; j++) {
  2652. ShaderUniform info;
  2653. info.type = UniformType(set_ptr[j].type);
  2654. info.writable = set_ptr[j].writable;
  2655. info.length = set_ptr[j].length;
  2656. info.binding = set_ptr[j].binding;
  2657. info.stages = set_ptr[j].stages;
  2658. VkDescriptorSetLayoutBinding layout_binding = {};
  2659. layout_binding.binding = set_ptr[j].binding;
  2660. layout_binding.descriptorCount = 1;
  2661. for (uint32_t k = 0; k < SHADER_STAGE_MAX; k++) {
  2662. if ((set_ptr[j].stages & (1 << k))) {
  2663. layout_binding.stageFlags |= RD_STAGE_TO_VK_SHADER_STAGE_BITS[k];
  2664. }
  2665. }
  2666. switch (info.type) {
  2667. case UNIFORM_TYPE_SAMPLER: {
  2668. layout_binding.descriptorType = VK_DESCRIPTOR_TYPE_SAMPLER;
  2669. layout_binding.descriptorCount = set_ptr[j].length;
  2670. } break;
  2671. case UNIFORM_TYPE_SAMPLER_WITH_TEXTURE: {
  2672. layout_binding.descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
  2673. layout_binding.descriptorCount = set_ptr[j].length;
  2674. } break;
  2675. case UNIFORM_TYPE_TEXTURE: {
  2676. layout_binding.descriptorType = VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE;
  2677. layout_binding.descriptorCount = set_ptr[j].length;
  2678. } break;
  2679. case UNIFORM_TYPE_IMAGE: {
  2680. layout_binding.descriptorType = VK_DESCRIPTOR_TYPE_STORAGE_IMAGE;
  2681. layout_binding.descriptorCount = set_ptr[j].length;
  2682. } break;
  2683. case UNIFORM_TYPE_TEXTURE_BUFFER: {
  2684. layout_binding.descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER;
  2685. layout_binding.descriptorCount = set_ptr[j].length;
  2686. } break;
  2687. case UNIFORM_TYPE_IMAGE_BUFFER: {
  2688. layout_binding.descriptorType = VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER;
  2689. } break;
  2690. case UNIFORM_TYPE_UNIFORM_BUFFER: {
  2691. layout_binding.descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
  2692. } break;
  2693. case UNIFORM_TYPE_STORAGE_BUFFER: {
  2694. layout_binding.descriptorType = VK_DESCRIPTOR_TYPE_STORAGE_BUFFER;
  2695. } break;
  2696. case UNIFORM_TYPE_INPUT_ATTACHMENT: {
  2697. layout_binding.descriptorType = VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT;
  2698. } break;
  2699. default: {
  2700. DEV_ASSERT(false);
  2701. }
  2702. }
  2703. r_shader_desc.uniform_sets.write[i].push_back(info);
  2704. vk_set_bindings.write[i].push_back(layout_binding);
  2705. }
  2706. read_offset += set_size;
  2707. }
  2708. ERR_FAIL_COND_V(read_offset + binary_data.specialization_constants_count * sizeof(ShaderBinary::SpecializationConstant) >= binsize, ShaderID());
  2709. r_shader_desc.specialization_constants.resize(binary_data.specialization_constants_count);
  2710. for (uint32_t i = 0; i < binary_data.specialization_constants_count; i++) {
  2711. const ShaderBinary::SpecializationConstant &src_sc = *(reinterpret_cast<const ShaderBinary::SpecializationConstant *>(binptr + read_offset));
  2712. ShaderSpecializationConstant sc;
  2713. sc.type = PipelineSpecializationConstantType(src_sc.type);
  2714. sc.constant_id = src_sc.constant_id;
  2715. sc.int_value = src_sc.int_value;
  2716. sc.stages = src_sc.stage_flags;
  2717. r_shader_desc.specialization_constants.write[i] = sc;
  2718. read_offset += sizeof(ShaderBinary::SpecializationConstant);
  2719. }
  2720. Vector<Vector<uint8_t>> stages_spirv;
  2721. stages_spirv.resize(binary_data.stage_count);
  2722. r_shader_desc.stages.resize(binary_data.stage_count);
  2723. for (uint32_t i = 0; i < binary_data.stage_count; i++) {
  2724. ERR_FAIL_COND_V(read_offset + sizeof(uint32_t) * 3 >= binsize, ShaderID());
  2725. uint32_t stage = decode_uint32(binptr + read_offset);
  2726. read_offset += sizeof(uint32_t);
  2727. uint32_t smolv_size = decode_uint32(binptr + read_offset);
  2728. read_offset += sizeof(uint32_t);
  2729. uint32_t zstd_size = decode_uint32(binptr + read_offset);
  2730. read_offset += sizeof(uint32_t);
  2731. uint32_t buf_size = (zstd_size > 0) ? zstd_size : smolv_size;
  2732. Vector<uint8_t> smolv;
  2733. const uint8_t *src_smolv = nullptr;
  2734. if (zstd_size > 0) {
  2735. // Decompress to smolv.
  2736. smolv.resize(smolv_size);
  2737. int dec_smolv_size = Compression::decompress(smolv.ptrw(), smolv.size(), binptr + read_offset, zstd_size, Compression::MODE_ZSTD);
  2738. ERR_FAIL_COND_V(dec_smolv_size != (int32_t)smolv_size, ShaderID());
  2739. src_smolv = smolv.ptr();
  2740. } else {
  2741. src_smolv = binptr + read_offset;
  2742. }
  2743. Vector<uint8_t> &spirv = stages_spirv.ptrw()[i];
  2744. uint32_t spirv_size = smolv::GetDecodedBufferSize(src_smolv, smolv_size);
  2745. spirv.resize(spirv_size);
  2746. if (!smolv::Decode(src_smolv, smolv_size, spirv.ptrw(), spirv_size)) {
  2747. ERR_FAIL_V_MSG(ShaderID(), "Malformed smolv input uncompressing shader stage:" + String(SHADER_STAGE_NAMES[stage]));
  2748. }
  2749. r_shader_desc.stages.set(i, ShaderStage(stage));
  2750. buf_size = STEPIFY(buf_size, 4);
  2751. read_offset += buf_size;
  2752. ERR_FAIL_COND_V(read_offset > binsize, ShaderID());
  2753. }
  2754. ERR_FAIL_COND_V(read_offset != binsize, ShaderID());
  2755. // Modules.
  2756. String error_text;
  2757. for (int i = 0; i < r_shader_desc.stages.size(); i++) {
  2758. VkShaderModuleCreateInfo shader_module_create_info = {};
  2759. shader_module_create_info.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
  2760. shader_module_create_info.codeSize = stages_spirv[i].size();
  2761. shader_module_create_info.pCode = (const uint32_t *)stages_spirv[i].ptr();
  2762. VkShaderModule vk_module = VK_NULL_HANDLE;
  2763. VkResult res = vkCreateShaderModule(vk_device, &shader_module_create_info, nullptr, &vk_module);
  2764. if (res) {
  2765. error_text = "Error (" + itos(res) + ") creating shader module for stage: " + String(SHADER_STAGE_NAMES[r_shader_desc.stages[i]]);
  2766. break;
  2767. }
  2768. VkPipelineShaderStageCreateInfo create_info = {};
  2769. create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
  2770. create_info.stage = RD_STAGE_TO_VK_SHADER_STAGE_BITS[r_shader_desc.stages[i]];
  2771. create_info.module = vk_module;
  2772. create_info.pName = "main";
  2773. shader_info.vk_stages_create_info.push_back(create_info);
  2774. }
  2775. // Descriptor sets.
  2776. if (error_text.is_empty()) {
  2777. DEV_ASSERT((uint32_t)vk_set_bindings.size() == binary_data.set_count);
  2778. for (uint32_t i = 0; i < binary_data.set_count; i++) {
  2779. // Empty ones are fine if they were not used according to spec (binding count will be 0).
  2780. VkDescriptorSetLayoutCreateInfo layout_create_info = {};
  2781. layout_create_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO;
  2782. layout_create_info.bindingCount = vk_set_bindings[i].size();
  2783. layout_create_info.pBindings = vk_set_bindings[i].ptr();
  2784. VkDescriptorSetLayout layout = VK_NULL_HANDLE;
  2785. VkResult res = vkCreateDescriptorSetLayout(vk_device, &layout_create_info, nullptr, &layout);
  2786. if (res) {
  2787. error_text = "Error (" + itos(res) + ") creating descriptor set layout for set " + itos(i);
  2788. break;
  2789. }
  2790. shader_info.vk_descriptor_set_layouts.push_back(layout);
  2791. }
  2792. }
  2793. if (error_text.is_empty()) {
  2794. // Pipeline layout.
  2795. VkPipelineLayoutCreateInfo pipeline_layout_create_info = {};
  2796. pipeline_layout_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO;
  2797. pipeline_layout_create_info.setLayoutCount = binary_data.set_count;
  2798. pipeline_layout_create_info.pSetLayouts = shader_info.vk_descriptor_set_layouts.ptr();
  2799. if (binary_data.push_constant_size) {
  2800. VkPushConstantRange *push_constant_range = ALLOCA_SINGLE(VkPushConstantRange);
  2801. *push_constant_range = {};
  2802. push_constant_range->stageFlags = binary_data.vk_push_constant_stages_mask;
  2803. push_constant_range->size = binary_data.push_constant_size;
  2804. pipeline_layout_create_info.pushConstantRangeCount = 1;
  2805. pipeline_layout_create_info.pPushConstantRanges = push_constant_range;
  2806. }
  2807. VkResult err = vkCreatePipelineLayout(vk_device, &pipeline_layout_create_info, nullptr, &shader_info.vk_pipeline_layout);
  2808. if (err) {
  2809. error_text = "Error (" + itos(err) + ") creating pipeline layout.";
  2810. }
  2811. }
  2812. if (!error_text.is_empty()) {
  2813. // Clean up if failed.
  2814. for (uint32_t i = 0; i < shader_info.vk_stages_create_info.size(); i++) {
  2815. vkDestroyShaderModule(vk_device, shader_info.vk_stages_create_info[i].module, nullptr);
  2816. }
  2817. for (uint32_t i = 0; i < binary_data.set_count; i++) {
  2818. vkDestroyDescriptorSetLayout(vk_device, shader_info.vk_descriptor_set_layouts[i], nullptr);
  2819. }
  2820. ERR_FAIL_V_MSG(ShaderID(), error_text);
  2821. }
  2822. // Bookkeep.
  2823. ShaderInfo *shader_info_ptr = VersatileResource::allocate<ShaderInfo>(resources_allocator);
  2824. *shader_info_ptr = shader_info;
  2825. return ShaderID(shader_info_ptr);
  2826. }
  2827. void RenderingDeviceDriverVulkan::shader_free(ShaderID p_shader) {
  2828. ShaderInfo *shader_info = (ShaderInfo *)p_shader.id;
  2829. for (uint32_t i = 0; i < shader_info->vk_descriptor_set_layouts.size(); i++) {
  2830. vkDestroyDescriptorSetLayout(vk_device, shader_info->vk_descriptor_set_layouts[i], nullptr);
  2831. }
  2832. vkDestroyPipelineLayout(vk_device, shader_info->vk_pipeline_layout, nullptr);
  2833. for (uint32_t i = 0; i < shader_info->vk_stages_create_info.size(); i++) {
  2834. vkDestroyShaderModule(vk_device, shader_info->vk_stages_create_info[i].module, nullptr);
  2835. }
  2836. VersatileResource::free(resources_allocator, shader_info);
  2837. }
  2838. /*********************/
  2839. /**** UNIFORM SET ****/
  2840. /*********************/
  2841. VkDescriptorPool RenderingDeviceDriverVulkan::_descriptor_set_pool_find_or_create(const DescriptorSetPoolKey &p_key, DescriptorSetPools::Iterator *r_pool_sets_it) {
  2842. DescriptorSetPools::Iterator pool_sets_it = descriptor_set_pools.find(p_key);
  2843. if (pool_sets_it) {
  2844. for (KeyValue<VkDescriptorPool, uint32_t> &E : pool_sets_it->value) {
  2845. if (E.value < max_descriptor_sets_per_pool) {
  2846. *r_pool_sets_it = pool_sets_it;
  2847. return E.key;
  2848. }
  2849. }
  2850. }
  2851. // Create a new one.
  2852. // Here comes more vulkan API strangeness.
  2853. VkDescriptorPoolSize *vk_sizes = ALLOCA_ARRAY(VkDescriptorPoolSize, UNIFORM_TYPE_MAX);
  2854. uint32_t vk_sizes_count = 0;
  2855. {
  2856. VkDescriptorPoolSize *curr_vk_size = vk_sizes;
  2857. if (p_key.uniform_type[UNIFORM_TYPE_SAMPLER]) {
  2858. *curr_vk_size = {};
  2859. curr_vk_size->type = VK_DESCRIPTOR_TYPE_SAMPLER;
  2860. curr_vk_size->descriptorCount = p_key.uniform_type[UNIFORM_TYPE_SAMPLER] * max_descriptor_sets_per_pool;
  2861. curr_vk_size++;
  2862. vk_sizes_count++;
  2863. }
  2864. if (p_key.uniform_type[UNIFORM_TYPE_SAMPLER_WITH_TEXTURE]) {
  2865. *curr_vk_size = {};
  2866. curr_vk_size->type = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
  2867. curr_vk_size->descriptorCount = p_key.uniform_type[UNIFORM_TYPE_SAMPLER_WITH_TEXTURE] * max_descriptor_sets_per_pool;
  2868. curr_vk_size++;
  2869. vk_sizes_count++;
  2870. }
  2871. if (p_key.uniform_type[UNIFORM_TYPE_TEXTURE]) {
  2872. *curr_vk_size = {};
  2873. curr_vk_size->type = VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE;
  2874. curr_vk_size->descriptorCount = p_key.uniform_type[UNIFORM_TYPE_TEXTURE] * max_descriptor_sets_per_pool;
  2875. curr_vk_size++;
  2876. vk_sizes_count++;
  2877. }
  2878. if (p_key.uniform_type[UNIFORM_TYPE_IMAGE]) {
  2879. *curr_vk_size = {};
  2880. curr_vk_size->type = VK_DESCRIPTOR_TYPE_STORAGE_IMAGE;
  2881. curr_vk_size->descriptorCount = p_key.uniform_type[UNIFORM_TYPE_IMAGE] * max_descriptor_sets_per_pool;
  2882. curr_vk_size++;
  2883. vk_sizes_count++;
  2884. }
  2885. if (p_key.uniform_type[UNIFORM_TYPE_TEXTURE_BUFFER] || p_key.uniform_type[UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER]) {
  2886. *curr_vk_size = {};
  2887. curr_vk_size->type = VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER;
  2888. curr_vk_size->descriptorCount = (p_key.uniform_type[UNIFORM_TYPE_TEXTURE_BUFFER] + p_key.uniform_type[UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER]) * max_descriptor_sets_per_pool;
  2889. curr_vk_size++;
  2890. vk_sizes_count++;
  2891. }
  2892. if (p_key.uniform_type[UNIFORM_TYPE_IMAGE_BUFFER]) {
  2893. *curr_vk_size = {};
  2894. curr_vk_size->type = VK_DESCRIPTOR_TYPE_STORAGE_TEXEL_BUFFER;
  2895. curr_vk_size->descriptorCount = p_key.uniform_type[UNIFORM_TYPE_IMAGE_BUFFER] * max_descriptor_sets_per_pool;
  2896. curr_vk_size++;
  2897. vk_sizes_count++;
  2898. }
  2899. if (p_key.uniform_type[UNIFORM_TYPE_UNIFORM_BUFFER]) {
  2900. *curr_vk_size = {};
  2901. curr_vk_size->type = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
  2902. curr_vk_size->descriptorCount = p_key.uniform_type[UNIFORM_TYPE_UNIFORM_BUFFER] * max_descriptor_sets_per_pool;
  2903. curr_vk_size++;
  2904. vk_sizes_count++;
  2905. }
  2906. if (p_key.uniform_type[UNIFORM_TYPE_STORAGE_BUFFER]) {
  2907. *curr_vk_size = {};
  2908. curr_vk_size->type = VK_DESCRIPTOR_TYPE_STORAGE_BUFFER;
  2909. curr_vk_size->descriptorCount = p_key.uniform_type[UNIFORM_TYPE_STORAGE_BUFFER] * max_descriptor_sets_per_pool;
  2910. curr_vk_size++;
  2911. vk_sizes_count++;
  2912. }
  2913. if (p_key.uniform_type[UNIFORM_TYPE_INPUT_ATTACHMENT]) {
  2914. *curr_vk_size = {};
  2915. curr_vk_size->type = VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT;
  2916. curr_vk_size->descriptorCount = p_key.uniform_type[UNIFORM_TYPE_INPUT_ATTACHMENT] * max_descriptor_sets_per_pool;
  2917. curr_vk_size++;
  2918. vk_sizes_count++;
  2919. }
  2920. DEV_ASSERT(vk_sizes_count <= UNIFORM_TYPE_MAX);
  2921. }
  2922. VkDescriptorPoolCreateInfo descriptor_set_pool_create_info = {};
  2923. descriptor_set_pool_create_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO;
  2924. descriptor_set_pool_create_info.flags = VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT; // Can't think how somebody may NOT need this flag.
  2925. descriptor_set_pool_create_info.maxSets = max_descriptor_sets_per_pool;
  2926. descriptor_set_pool_create_info.poolSizeCount = vk_sizes_count;
  2927. descriptor_set_pool_create_info.pPoolSizes = vk_sizes;
  2928. VkDescriptorPool vk_pool = VK_NULL_HANDLE;
  2929. VkResult res = vkCreateDescriptorPool(vk_device, &descriptor_set_pool_create_info, nullptr, &vk_pool);
  2930. if (res) {
  2931. ERR_FAIL_COND_V_MSG(res, VK_NULL_HANDLE, "vkCreateDescriptorPool failed with error " + itos(res) + ".");
  2932. }
  2933. // Bookkeep.
  2934. if (!pool_sets_it) {
  2935. pool_sets_it = descriptor_set_pools.insert(p_key, HashMap<VkDescriptorPool, uint32_t>());
  2936. }
  2937. HashMap<VkDescriptorPool, uint32_t> &pool_rcs = pool_sets_it->value;
  2938. pool_rcs.insert(vk_pool, 0);
  2939. *r_pool_sets_it = pool_sets_it;
  2940. return vk_pool;
  2941. }
  2942. void RenderingDeviceDriverVulkan::_descriptor_set_pool_unreference(DescriptorSetPools::Iterator p_pool_sets_it, VkDescriptorPool p_vk_descriptor_pool) {
  2943. HashMap<VkDescriptorPool, uint32_t>::Iterator pool_rcs_it = p_pool_sets_it->value.find(p_vk_descriptor_pool);
  2944. pool_rcs_it->value--;
  2945. if (pool_rcs_it->value == 0) {
  2946. vkDestroyDescriptorPool(vk_device, p_vk_descriptor_pool, nullptr);
  2947. p_pool_sets_it->value.erase(p_vk_descriptor_pool);
  2948. if (p_pool_sets_it->value.is_empty()) {
  2949. descriptor_set_pools.remove(p_pool_sets_it);
  2950. }
  2951. }
  2952. }
  2953. RDD::UniformSetID RenderingDeviceDriverVulkan::uniform_set_create(VectorView<BoundUniform> p_uniforms, ShaderID p_shader, uint32_t p_set_index) {
  2954. DescriptorSetPoolKey pool_key;
  2955. VkWriteDescriptorSet *vk_writes = ALLOCA_ARRAY(VkWriteDescriptorSet, p_uniforms.size());
  2956. for (uint32_t i = 0; i < p_uniforms.size(); i++) {
  2957. const BoundUniform &uniform = p_uniforms[i];
  2958. vk_writes[i] = {};
  2959. vk_writes[i].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
  2960. vk_writes[i].dstBinding = uniform.binding;
  2961. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_MAX_ENUM; // Invalid value.
  2962. uint32_t num_descriptors = 1;
  2963. switch (uniform.type) {
  2964. case UNIFORM_TYPE_SAMPLER: {
  2965. num_descriptors = uniform.ids.size();
  2966. VkDescriptorImageInfo *vk_img_infos = ALLOCA_ARRAY(VkDescriptorImageInfo, num_descriptors);
  2967. for (uint32_t j = 0; j < num_descriptors; j++) {
  2968. vk_img_infos[j] = {};
  2969. vk_img_infos[j].sampler = (VkSampler)uniform.ids[j].id;
  2970. vk_img_infos[j].imageView = VK_NULL_HANDLE;
  2971. vk_img_infos[j].imageLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  2972. }
  2973. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_SAMPLER;
  2974. vk_writes[i].pImageInfo = vk_img_infos;
  2975. } break;
  2976. case UNIFORM_TYPE_SAMPLER_WITH_TEXTURE: {
  2977. num_descriptors = uniform.ids.size() / 2;
  2978. VkDescriptorImageInfo *vk_img_infos = ALLOCA_ARRAY(VkDescriptorImageInfo, num_descriptors);
  2979. for (uint32_t j = 0; j < num_descriptors; j++) {
  2980. vk_img_infos[j] = {};
  2981. vk_img_infos[j].sampler = (VkSampler)uniform.ids[j * 2 + 0].id;
  2982. vk_img_infos[j].imageView = ((const TextureInfo *)uniform.ids[j * 2 + 1].id)->vk_view;
  2983. vk_img_infos[j].imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
  2984. }
  2985. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
  2986. vk_writes[i].pImageInfo = vk_img_infos;
  2987. } break;
  2988. case UNIFORM_TYPE_TEXTURE: {
  2989. num_descriptors = uniform.ids.size();
  2990. VkDescriptorImageInfo *vk_img_infos = ALLOCA_ARRAY(VkDescriptorImageInfo, num_descriptors);
  2991. for (uint32_t j = 0; j < num_descriptors; j++) {
  2992. vk_img_infos[j] = {};
  2993. vk_img_infos[j].imageView = ((const TextureInfo *)uniform.ids[j].id)->vk_view;
  2994. vk_img_infos[j].imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
  2995. }
  2996. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_SAMPLED_IMAGE;
  2997. vk_writes[i].pImageInfo = vk_img_infos;
  2998. } break;
  2999. case UNIFORM_TYPE_IMAGE: {
  3000. num_descriptors = uniform.ids.size();
  3001. VkDescriptorImageInfo *vk_img_infos = ALLOCA_ARRAY(VkDescriptorImageInfo, num_descriptors);
  3002. for (uint32_t j = 0; j < num_descriptors; j++) {
  3003. vk_img_infos[j] = {};
  3004. vk_img_infos[j].imageView = ((const TextureInfo *)uniform.ids[j].id)->vk_view;
  3005. vk_img_infos[j].imageLayout = VK_IMAGE_LAYOUT_GENERAL;
  3006. }
  3007. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_STORAGE_IMAGE;
  3008. vk_writes[i].pImageInfo = vk_img_infos;
  3009. } break;
  3010. case UNIFORM_TYPE_TEXTURE_BUFFER: {
  3011. num_descriptors = uniform.ids.size();
  3012. VkDescriptorBufferInfo *vk_buf_infos = ALLOCA_ARRAY(VkDescriptorBufferInfo, num_descriptors);
  3013. VkBufferView *vk_buf_views = ALLOCA_ARRAY(VkBufferView, num_descriptors);
  3014. for (uint32_t j = 0; j < num_descriptors; j++) {
  3015. const BufferInfo *buf_info = (const BufferInfo *)uniform.ids[j].id;
  3016. vk_buf_infos[j] = {};
  3017. vk_buf_infos[j].buffer = buf_info->vk_buffer;
  3018. vk_buf_infos[j].range = buf_info->size;
  3019. vk_buf_views[j] = buf_info->vk_view;
  3020. }
  3021. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER;
  3022. vk_writes[i].pBufferInfo = vk_buf_infos;
  3023. vk_writes[i].pTexelBufferView = vk_buf_views;
  3024. } break;
  3025. case UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER: {
  3026. num_descriptors = uniform.ids.size() / 2;
  3027. VkDescriptorImageInfo *vk_img_infos = ALLOCA_ARRAY(VkDescriptorImageInfo, num_descriptors);
  3028. VkDescriptorBufferInfo *vk_buf_infos = ALLOCA_ARRAY(VkDescriptorBufferInfo, num_descriptors);
  3029. VkBufferView *vk_buf_views = ALLOCA_ARRAY(VkBufferView, num_descriptors);
  3030. for (uint32_t j = 0; j < num_descriptors; j++) {
  3031. vk_img_infos[j] = {};
  3032. vk_img_infos[j].sampler = (VkSampler)uniform.ids[j * 2 + 0].id;
  3033. const BufferInfo *buf_info = (const BufferInfo *)uniform.ids[j * 2 + 1].id;
  3034. vk_buf_infos[j] = {};
  3035. vk_buf_infos[j].buffer = buf_info->vk_buffer;
  3036. vk_buf_infos[j].range = buf_info->size;
  3037. vk_buf_views[j] = buf_info->vk_view;
  3038. }
  3039. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_TEXEL_BUFFER;
  3040. vk_writes[i].pImageInfo = vk_img_infos;
  3041. vk_writes[i].pBufferInfo = vk_buf_infos;
  3042. vk_writes[i].pTexelBufferView = vk_buf_views;
  3043. } break;
  3044. case UNIFORM_TYPE_IMAGE_BUFFER: {
  3045. CRASH_NOW_MSG("Unimplemented!"); // TODO.
  3046. } break;
  3047. case UNIFORM_TYPE_UNIFORM_BUFFER: {
  3048. const BufferInfo *buf_info = (const BufferInfo *)uniform.ids[0].id;
  3049. VkDescriptorBufferInfo *vk_buf_info = ALLOCA_SINGLE(VkDescriptorBufferInfo);
  3050. *vk_buf_info = {};
  3051. vk_buf_info->buffer = buf_info->vk_buffer;
  3052. vk_buf_info->range = buf_info->size;
  3053. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_UNIFORM_BUFFER;
  3054. vk_writes[i].pBufferInfo = vk_buf_info;
  3055. } break;
  3056. case UNIFORM_TYPE_STORAGE_BUFFER: {
  3057. const BufferInfo *buf_info = (const BufferInfo *)uniform.ids[0].id;
  3058. VkDescriptorBufferInfo *vk_buf_info = ALLOCA_SINGLE(VkDescriptorBufferInfo);
  3059. *vk_buf_info = {};
  3060. vk_buf_info->buffer = buf_info->vk_buffer;
  3061. vk_buf_info->range = buf_info->size;
  3062. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_STORAGE_BUFFER;
  3063. vk_writes[i].pBufferInfo = vk_buf_info;
  3064. } break;
  3065. case UNIFORM_TYPE_INPUT_ATTACHMENT: {
  3066. num_descriptors = uniform.ids.size();
  3067. VkDescriptorImageInfo *vk_img_infos = ALLOCA_ARRAY(VkDescriptorImageInfo, num_descriptors);
  3068. for (uint32_t j = 0; j < uniform.ids.size(); j++) {
  3069. vk_img_infos[j] = {};
  3070. vk_img_infos[j].imageView = ((const TextureInfo *)uniform.ids[j].id)->vk_view;
  3071. vk_img_infos[j].imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
  3072. }
  3073. vk_writes[i].descriptorType = VK_DESCRIPTOR_TYPE_INPUT_ATTACHMENT;
  3074. vk_writes[i].pImageInfo = vk_img_infos;
  3075. } break;
  3076. default: {
  3077. DEV_ASSERT(false);
  3078. }
  3079. }
  3080. vk_writes[i].descriptorCount = num_descriptors;
  3081. ERR_FAIL_COND_V_MSG(pool_key.uniform_type[uniform.type] == MAX_UNIFORM_POOL_ELEMENT, UniformSetID(),
  3082. "Uniform set reached the limit of bindings for the same type (" + itos(MAX_UNIFORM_POOL_ELEMENT) + ").");
  3083. pool_key.uniform_type[uniform.type] += num_descriptors;
  3084. }
  3085. // Need a descriptor pool.
  3086. DescriptorSetPools::Iterator pool_sets_it = {};
  3087. VkDescriptorPool vk_pool = _descriptor_set_pool_find_or_create(pool_key, &pool_sets_it);
  3088. DEV_ASSERT(vk_pool);
  3089. pool_sets_it->value[vk_pool]++;
  3090. VkDescriptorSetAllocateInfo descriptor_set_allocate_info = {};
  3091. descriptor_set_allocate_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO;
  3092. descriptor_set_allocate_info.descriptorPool = vk_pool;
  3093. descriptor_set_allocate_info.descriptorSetCount = 1;
  3094. const ShaderInfo *shader_info = (const ShaderInfo *)p_shader.id;
  3095. descriptor_set_allocate_info.pSetLayouts = &shader_info->vk_descriptor_set_layouts[p_set_index];
  3096. VkDescriptorSet vk_descriptor_set = VK_NULL_HANDLE;
  3097. VkResult res = vkAllocateDescriptorSets(vk_device, &descriptor_set_allocate_info, &vk_descriptor_set);
  3098. if (res) {
  3099. _descriptor_set_pool_unreference(pool_sets_it, vk_pool);
  3100. ERR_FAIL_V_MSG(UniformSetID(), "Cannot allocate descriptor sets, error " + itos(res) + ".");
  3101. }
  3102. for (uint32_t i = 0; i < p_uniforms.size(); i++) {
  3103. vk_writes[i].dstSet = vk_descriptor_set;
  3104. }
  3105. vkUpdateDescriptorSets(vk_device, p_uniforms.size(), vk_writes, 0, nullptr);
  3106. // Bookkeep.
  3107. UniformSetInfo *usi = VersatileResource::allocate<UniformSetInfo>(resources_allocator);
  3108. usi->vk_descriptor_set = vk_descriptor_set;
  3109. usi->vk_descriptor_pool = vk_pool;
  3110. usi->pool_sets_it = pool_sets_it;
  3111. return UniformSetID(usi);
  3112. }
  3113. void RenderingDeviceDriverVulkan::uniform_set_free(UniformSetID p_uniform_set) {
  3114. UniformSetInfo *usi = (UniformSetInfo *)p_uniform_set.id;
  3115. vkFreeDescriptorSets(vk_device, usi->vk_descriptor_pool, 1, &usi->vk_descriptor_set);
  3116. _descriptor_set_pool_unreference(usi->pool_sets_it, usi->vk_descriptor_pool);
  3117. VersatileResource::free(resources_allocator, usi);
  3118. }
  3119. // ----- COMMANDS -----
  3120. void RenderingDeviceDriverVulkan::command_uniform_set_prepare_for_use(CommandBufferID p_cmd_buffer, UniformSetID p_uniform_set, ShaderID p_shader, uint32_t p_set_index) {
  3121. }
  3122. /******************/
  3123. /**** TRANSFER ****/
  3124. /******************/
  3125. static_assert(ARRAYS_COMPATIBLE_FIELDWISE(RDD::BufferCopyRegion, VkBufferCopy));
  3126. static void _texture_subresource_range_to_vk(const RDD::TextureSubresourceRange &p_subresources, VkImageSubresourceRange *r_vk_subreources) {
  3127. *r_vk_subreources = {};
  3128. r_vk_subreources->aspectMask = (VkImageAspectFlags)p_subresources.aspect;
  3129. r_vk_subreources->baseMipLevel = p_subresources.base_mipmap;
  3130. r_vk_subreources->levelCount = p_subresources.mipmap_count;
  3131. r_vk_subreources->baseArrayLayer = p_subresources.base_layer;
  3132. r_vk_subreources->layerCount = p_subresources.layer_count;
  3133. }
  3134. static void _texture_subresource_layers_to_vk(const RDD::TextureSubresourceLayers &p_subresources, VkImageSubresourceLayers *r_vk_subreources) {
  3135. *r_vk_subreources = {};
  3136. r_vk_subreources->aspectMask = (VkImageAspectFlags)p_subresources.aspect;
  3137. r_vk_subreources->mipLevel = p_subresources.mipmap;
  3138. r_vk_subreources->baseArrayLayer = p_subresources.base_layer;
  3139. r_vk_subreources->layerCount = p_subresources.layer_count;
  3140. }
  3141. static void _buffer_texture_copy_region_to_vk(const RDD::BufferTextureCopyRegion &p_copy_region, VkBufferImageCopy *r_vk_copy_region) {
  3142. *r_vk_copy_region = {};
  3143. r_vk_copy_region->bufferOffset = p_copy_region.buffer_offset;
  3144. _texture_subresource_layers_to_vk(p_copy_region.texture_subresources, &r_vk_copy_region->imageSubresource);
  3145. r_vk_copy_region->imageOffset.x = p_copy_region.texture_offset.x;
  3146. r_vk_copy_region->imageOffset.y = p_copy_region.texture_offset.y;
  3147. r_vk_copy_region->imageOffset.z = p_copy_region.texture_offset.z;
  3148. r_vk_copy_region->imageExtent.width = p_copy_region.texture_region_size.x;
  3149. r_vk_copy_region->imageExtent.height = p_copy_region.texture_region_size.y;
  3150. r_vk_copy_region->imageExtent.depth = p_copy_region.texture_region_size.z;
  3151. }
  3152. static void _texture_copy_region_to_vk(const RDD::TextureCopyRegion &p_copy_region, VkImageCopy *r_vk_copy_region) {
  3153. *r_vk_copy_region = {};
  3154. _texture_subresource_layers_to_vk(p_copy_region.src_subresources, &r_vk_copy_region->srcSubresource);
  3155. r_vk_copy_region->srcOffset.x = p_copy_region.src_offset.x;
  3156. r_vk_copy_region->srcOffset.y = p_copy_region.src_offset.y;
  3157. r_vk_copy_region->srcOffset.z = p_copy_region.src_offset.z;
  3158. _texture_subresource_layers_to_vk(p_copy_region.dst_subresources, &r_vk_copy_region->dstSubresource);
  3159. r_vk_copy_region->dstOffset.x = p_copy_region.dst_offset.x;
  3160. r_vk_copy_region->dstOffset.y = p_copy_region.dst_offset.y;
  3161. r_vk_copy_region->dstOffset.z = p_copy_region.dst_offset.z;
  3162. r_vk_copy_region->extent.width = p_copy_region.size.x;
  3163. r_vk_copy_region->extent.height = p_copy_region.size.y;
  3164. r_vk_copy_region->extent.depth = p_copy_region.size.z;
  3165. }
  3166. void RenderingDeviceDriverVulkan::command_clear_buffer(CommandBufferID p_cmd_buffer, BufferID p_buffer, uint64_t p_offset, uint64_t p_size) {
  3167. const BufferInfo *buf_info = (const BufferInfo *)p_buffer.id;
  3168. vkCmdFillBuffer((VkCommandBuffer)p_cmd_buffer.id, buf_info->vk_buffer, p_offset, p_size, 0);
  3169. }
  3170. void RenderingDeviceDriverVulkan::command_copy_buffer(CommandBufferID p_cmd_buffer, BufferID p_src_buffer, BufferID p_dst_buffer, VectorView<BufferCopyRegion> p_regions) {
  3171. const BufferInfo *src_buf_info = (const BufferInfo *)p_src_buffer.id;
  3172. const BufferInfo *dst_buf_info = (const BufferInfo *)p_dst_buffer.id;
  3173. vkCmdCopyBuffer((VkCommandBuffer)p_cmd_buffer.id, src_buf_info->vk_buffer, dst_buf_info->vk_buffer, p_regions.size(), (const VkBufferCopy *)p_regions.ptr());
  3174. }
  3175. void RenderingDeviceDriverVulkan::command_copy_texture(CommandBufferID p_cmd_buffer, TextureID p_src_texture, TextureLayout p_src_texture_layout, TextureID p_dst_texture, TextureLayout p_dst_texture_layout, VectorView<TextureCopyRegion> p_regions) {
  3176. VkImageCopy *vk_copy_regions = ALLOCA_ARRAY(VkImageCopy, p_regions.size());
  3177. for (uint32_t i = 0; i < p_regions.size(); i++) {
  3178. _texture_copy_region_to_vk(p_regions[i], &vk_copy_regions[i]);
  3179. }
  3180. const TextureInfo *src_tex_info = (const TextureInfo *)p_src_texture.id;
  3181. const TextureInfo *dst_tex_info = (const TextureInfo *)p_dst_texture.id;
  3182. vkCmdCopyImage((VkCommandBuffer)p_cmd_buffer.id, src_tex_info->vk_view_create_info.image, (VkImageLayout)p_src_texture_layout, dst_tex_info->vk_view_create_info.image, (VkImageLayout)p_dst_texture_layout, p_regions.size(), vk_copy_regions);
  3183. }
  3184. void RenderingDeviceDriverVulkan::command_resolve_texture(CommandBufferID p_cmd_buffer, TextureID p_src_texture, TextureLayout p_src_texture_layout, uint32_t p_src_layer, uint32_t p_src_mipmap, TextureID p_dst_texture, TextureLayout p_dst_texture_layout, uint32_t p_dst_layer, uint32_t p_dst_mipmap) {
  3185. const TextureInfo *src_tex_info = (const TextureInfo *)p_src_texture.id;
  3186. const TextureInfo *dst_tex_info = (const TextureInfo *)p_dst_texture.id;
  3187. VkImageResolve vk_resolve = {};
  3188. vk_resolve.srcSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  3189. vk_resolve.srcSubresource.mipLevel = p_src_mipmap;
  3190. vk_resolve.srcSubresource.baseArrayLayer = p_src_layer;
  3191. vk_resolve.srcSubresource.layerCount = 1;
  3192. vk_resolve.dstSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  3193. vk_resolve.dstSubresource.mipLevel = p_dst_mipmap;
  3194. vk_resolve.dstSubresource.baseArrayLayer = p_dst_layer;
  3195. vk_resolve.dstSubresource.layerCount = 1;
  3196. vk_resolve.extent.width = MAX(1u, src_tex_info->vk_create_info.extent.width >> p_src_mipmap);
  3197. vk_resolve.extent.height = MAX(1u, src_tex_info->vk_create_info.extent.height >> p_src_mipmap);
  3198. vk_resolve.extent.depth = MAX(1u, src_tex_info->vk_create_info.extent.depth >> p_src_mipmap);
  3199. vkCmdResolveImage((VkCommandBuffer)p_cmd_buffer.id, src_tex_info->vk_view_create_info.image, (VkImageLayout)p_src_texture_layout, dst_tex_info->vk_view_create_info.image, (VkImageLayout)p_dst_texture_layout, 1, &vk_resolve);
  3200. }
  3201. void RenderingDeviceDriverVulkan::command_clear_color_texture(CommandBufferID p_cmd_buffer, TextureID p_texture, TextureLayout p_texture_layout, const Color &p_color, const TextureSubresourceRange &p_subresources) {
  3202. VkClearColorValue vk_color = {};
  3203. memcpy(&vk_color.float32, p_color.components, sizeof(VkClearColorValue::float32));
  3204. VkImageSubresourceRange vk_subresources = {};
  3205. _texture_subresource_range_to_vk(p_subresources, &vk_subresources);
  3206. const TextureInfo *tex_info = (const TextureInfo *)p_texture.id;
  3207. vkCmdClearColorImage((VkCommandBuffer)p_cmd_buffer.id, tex_info->vk_view_create_info.image, (VkImageLayout)p_texture_layout, &vk_color, 1, &vk_subresources);
  3208. }
  3209. void RenderingDeviceDriverVulkan::command_copy_buffer_to_texture(CommandBufferID p_cmd_buffer, BufferID p_src_buffer, TextureID p_dst_texture, TextureLayout p_dst_texture_layout, VectorView<BufferTextureCopyRegion> p_regions) {
  3210. VkBufferImageCopy *vk_copy_regions = ALLOCA_ARRAY(VkBufferImageCopy, p_regions.size());
  3211. for (uint32_t i = 0; i < p_regions.size(); i++) {
  3212. _buffer_texture_copy_region_to_vk(p_regions[i], &vk_copy_regions[i]);
  3213. }
  3214. const BufferInfo *buf_info = (const BufferInfo *)p_src_buffer.id;
  3215. const TextureInfo *tex_info = (const TextureInfo *)p_dst_texture.id;
  3216. vkCmdCopyBufferToImage((VkCommandBuffer)p_cmd_buffer.id, buf_info->vk_buffer, tex_info->vk_view_create_info.image, (VkImageLayout)p_dst_texture_layout, p_regions.size(), vk_copy_regions);
  3217. }
  3218. void RenderingDeviceDriverVulkan::command_copy_texture_to_buffer(CommandBufferID p_cmd_buffer, TextureID p_src_texture, TextureLayout p_src_texture_layout, BufferID p_dst_buffer, VectorView<BufferTextureCopyRegion> p_regions) {
  3219. VkBufferImageCopy *vk_copy_regions = ALLOCA_ARRAY(VkBufferImageCopy, p_regions.size());
  3220. for (uint32_t i = 0; i < p_regions.size(); i++) {
  3221. _buffer_texture_copy_region_to_vk(p_regions[i], &vk_copy_regions[i]);
  3222. }
  3223. const TextureInfo *tex_info = (const TextureInfo *)p_src_texture.id;
  3224. const BufferInfo *buf_info = (const BufferInfo *)p_dst_buffer.id;
  3225. vkCmdCopyImageToBuffer((VkCommandBuffer)p_cmd_buffer.id, tex_info->vk_view_create_info.image, (VkImageLayout)p_src_texture_layout, buf_info->vk_buffer, p_regions.size(), vk_copy_regions);
  3226. }
  3227. /******************/
  3228. /**** PIPELINE ****/
  3229. /******************/
  3230. void RenderingDeviceDriverVulkan::pipeline_free(PipelineID p_pipeline) {
  3231. vkDestroyPipeline(vk_device, (VkPipeline)p_pipeline.id, nullptr);
  3232. }
  3233. // ----- BINDING -----
  3234. void RenderingDeviceDriverVulkan::command_bind_push_constants(CommandBufferID p_cmd_buffer, ShaderID p_shader, uint32_t p_dst_first_index, VectorView<uint32_t> p_data) {
  3235. const ShaderInfo *shader_info = (const ShaderInfo *)p_shader.id;
  3236. vkCmdPushConstants((VkCommandBuffer)p_cmd_buffer.id, shader_info->vk_pipeline_layout, shader_info->vk_push_constant_stages, p_dst_first_index * sizeof(uint32_t), p_data.size() * sizeof(uint32_t), p_data.ptr());
  3237. }
  3238. // ----- CACHE -----
  3239. int RenderingDeviceDriverVulkan::caching_instance_count = 0;
  3240. bool RenderingDeviceDriverVulkan::pipeline_cache_create(const Vector<uint8_t> &p_data) {
  3241. if (caching_instance_count) {
  3242. WARN_PRINT("There's already a RenderingDeviceDriverVulkan instance doing PSO caching. Only one can at the same time. This one won't.");
  3243. return false;
  3244. }
  3245. caching_instance_count++;
  3246. pipelines_cache.current_size = 0;
  3247. pipelines_cache.buffer.resize(sizeof(PipelineCacheHeader));
  3248. // Parse.
  3249. {
  3250. if (p_data.is_empty()) {
  3251. // No pre-existing cache, just create it.
  3252. } else if (p_data.size() <= (int)sizeof(PipelineCacheHeader)) {
  3253. WARN_PRINT("Invalid/corrupt pipelines cache.");
  3254. } else {
  3255. const PipelineCacheHeader *loaded_header = reinterpret_cast<const PipelineCacheHeader *>(p_data.ptr());
  3256. if (loaded_header->magic != 868 + VK_PIPELINE_CACHE_HEADER_VERSION_ONE) {
  3257. WARN_PRINT("Invalid pipelines cache magic number.");
  3258. } else {
  3259. const uint8_t *loaded_buffer_start = p_data.ptr() + sizeof(PipelineCacheHeader);
  3260. uint32_t loaded_buffer_size = p_data.size() - sizeof(PipelineCacheHeader);
  3261. const PipelineCacheHeader *current_header = (PipelineCacheHeader *)pipelines_cache.buffer.ptr();
  3262. if (loaded_header->data_hash != hash_murmur3_buffer(loaded_buffer_start, loaded_buffer_size) ||
  3263. loaded_header->data_size != loaded_buffer_size ||
  3264. loaded_header->vendor_id != current_header->vendor_id ||
  3265. loaded_header->device_id != current_header->device_id ||
  3266. loaded_header->driver_version != current_header->driver_version ||
  3267. memcmp(loaded_header->uuid, current_header->uuid, VK_UUID_SIZE) != 0 ||
  3268. loaded_header->driver_abi != current_header->driver_abi) {
  3269. WARN_PRINT("Invalid pipelines cache header.");
  3270. } else {
  3271. pipelines_cache.current_size = loaded_buffer_size;
  3272. pipelines_cache.buffer = p_data;
  3273. }
  3274. }
  3275. }
  3276. }
  3277. // Create.
  3278. {
  3279. VkPipelineCacheCreateInfo cache_info = {};
  3280. cache_info.sType = VK_STRUCTURE_TYPE_PIPELINE_CACHE_CREATE_INFO;
  3281. cache_info.initialDataSize = pipelines_cache.buffer.size() - sizeof(PipelineCacheHeader);
  3282. cache_info.pInitialData = pipelines_cache.buffer.ptr() + sizeof(PipelineCacheHeader);
  3283. if (pipeline_cache_control_support) {
  3284. cache_info.flags = VK_PIPELINE_CACHE_CREATE_EXTERNALLY_SYNCHRONIZED_BIT;
  3285. }
  3286. VkResult err = vkCreatePipelineCache(vk_device, &cache_info, nullptr, &pipelines_cache.vk_cache);
  3287. if (err != VK_SUCCESS) {
  3288. WARN_PRINT("vkCreatePipelinecache failed with error " + itos(err) + ".");
  3289. return false;
  3290. }
  3291. }
  3292. return true;
  3293. }
  3294. void RenderingDeviceDriverVulkan::pipeline_cache_free() {
  3295. DEV_ASSERT(pipelines_cache.vk_cache);
  3296. vkDestroyPipelineCache(vk_device, pipelines_cache.vk_cache, nullptr);
  3297. pipelines_cache.vk_cache = VK_NULL_HANDLE;
  3298. DEV_ASSERT(caching_instance_count > 0);
  3299. caching_instance_count--;
  3300. }
  3301. size_t RenderingDeviceDriverVulkan::pipeline_cache_query_size() {
  3302. DEV_ASSERT(pipelines_cache.vk_cache);
  3303. // FIXME:
  3304. // We're letting the cache grow unboundedly. We may want to set at limit and see if implementations use LRU or the like.
  3305. // If we do, we won't be able to assume any longer that the cache is dirty if, and only if, it has grown.
  3306. VkResult err = vkGetPipelineCacheData(vk_device, pipelines_cache.vk_cache, &pipelines_cache.current_size, nullptr);
  3307. ERR_FAIL_COND_V_MSG(err, 0, "vkGetPipelineCacheData failed with error " + itos(err) + ".");
  3308. return pipelines_cache.current_size;
  3309. }
  3310. Vector<uint8_t> RenderingDeviceDriverVulkan::pipeline_cache_serialize() {
  3311. DEV_ASSERT(pipelines_cache.vk_cache);
  3312. pipelines_cache.buffer.resize(pipelines_cache.current_size + sizeof(PipelineCacheHeader));
  3313. VkResult err = vkGetPipelineCacheData(vk_device, pipelines_cache.vk_cache, &pipelines_cache.current_size, pipelines_cache.buffer.ptrw() + sizeof(PipelineCacheHeader));
  3314. ERR_FAIL_COND_V(err != VK_SUCCESS && err != VK_INCOMPLETE, Vector<uint8_t>()); // Incomplete is OK because the cache may have grown since the size was queried (unless when exiting).
  3315. // The real buffer size may now be bigger than the updated current_size.
  3316. // We take into account the new size but keep the buffer resized in a worst-case fashion.
  3317. PipelineCacheHeader *header = (PipelineCacheHeader *)pipelines_cache.buffer.ptrw();
  3318. header->data_size = pipelines_cache.current_size;
  3319. header->data_hash = hash_murmur3_buffer(pipelines_cache.buffer.ptr() + sizeof(PipelineCacheHeader), pipelines_cache.current_size);
  3320. return pipelines_cache.buffer;
  3321. }
  3322. /*******************/
  3323. /**** RENDERING ****/
  3324. /*******************/
  3325. // ----- SUBPASS -----
  3326. // RDD::AttachmentLoadOp == VkAttachmentLoadOp.
  3327. static_assert(ENUM_MEMBERS_EQUAL(RDD::ATTACHMENT_LOAD_OP_LOAD, VK_ATTACHMENT_LOAD_OP_LOAD));
  3328. static_assert(ENUM_MEMBERS_EQUAL(RDD::ATTACHMENT_LOAD_OP_CLEAR, VK_ATTACHMENT_LOAD_OP_CLEAR));
  3329. static_assert(ENUM_MEMBERS_EQUAL(RDD::ATTACHMENT_LOAD_OP_DONT_CARE, VK_ATTACHMENT_LOAD_OP_DONT_CARE));
  3330. // RDD::AttachmentStoreOp == VkAttachmentStoreOp.
  3331. static_assert(ENUM_MEMBERS_EQUAL(RDD::ATTACHMENT_STORE_OP_STORE, VK_ATTACHMENT_STORE_OP_STORE));
  3332. static_assert(ENUM_MEMBERS_EQUAL(RDD::ATTACHMENT_STORE_OP_DONT_CARE, VK_ATTACHMENT_STORE_OP_DONT_CARE));
  3333. // Assuming Vulkan and RDD's are backed by uint32_t in:
  3334. // - VkSubpassDescription2::pPreserveAttachments and RDD::Subpass::preserve_attachments.
  3335. // - VkRenderPassCreateInfo2KHR::pCorrelatedViewMasks and p_view_correlation_mask.
  3336. static void _attachment_reference_to_vk(const RDD::AttachmentReference &p_attachment_reference, VkAttachmentReference2KHR *r_vk_attachment_reference) {
  3337. *r_vk_attachment_reference = {};
  3338. r_vk_attachment_reference->sType = VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2_KHR;
  3339. r_vk_attachment_reference->attachment = p_attachment_reference.attachment;
  3340. r_vk_attachment_reference->layout = (VkImageLayout)p_attachment_reference.layout;
  3341. r_vk_attachment_reference->aspectMask = (VkImageAspectFlags)p_attachment_reference.aspect;
  3342. }
  3343. RDD::RenderPassID RenderingDeviceDriverVulkan::render_pass_create(VectorView<Attachment> p_attachments, VectorView<Subpass> p_subpasses, VectorView<SubpassDependency> p_subpass_dependencies, uint32_t p_view_count) {
  3344. // These are only used if we use multiview but we need to define them in scope.
  3345. const uint32_t view_mask = (1 << p_view_count) - 1;
  3346. const uint32_t correlation_mask = (1 << p_view_count) - 1;
  3347. VkAttachmentDescription2KHR *vk_attachments = ALLOCA_ARRAY(VkAttachmentDescription2KHR, p_attachments.size());
  3348. for (uint32_t i = 0; i < p_attachments.size(); i++) {
  3349. vk_attachments[i] = {};
  3350. vk_attachments[i].sType = VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_2_KHR;
  3351. vk_attachments[i].format = RD_TO_VK_FORMAT[p_attachments[i].format];
  3352. vk_attachments[i].samples = _ensure_supported_sample_count(p_attachments[i].samples);
  3353. vk_attachments[i].loadOp = (VkAttachmentLoadOp)p_attachments[i].load_op;
  3354. vk_attachments[i].storeOp = (VkAttachmentStoreOp)p_attachments[i].store_op;
  3355. vk_attachments[i].stencilLoadOp = (VkAttachmentLoadOp)p_attachments[i].stencil_load_op;
  3356. vk_attachments[i].stencilStoreOp = (VkAttachmentStoreOp)p_attachments[i].stencil_store_op;
  3357. vk_attachments[i].initialLayout = (VkImageLayout)p_attachments[i].initial_layout;
  3358. vk_attachments[i].finalLayout = (VkImageLayout)p_attachments[i].final_layout;
  3359. }
  3360. VkSubpassDescription2KHR *vk_subpasses = ALLOCA_ARRAY(VkSubpassDescription2KHR, p_subpasses.size());
  3361. for (uint32_t i = 0; i < p_subpasses.size(); i++) {
  3362. VkAttachmentReference2KHR *vk_subpass_input_attachments = ALLOCA_ARRAY(VkAttachmentReference2KHR, p_subpasses[i].input_references.size());
  3363. for (uint32_t j = 0; j < p_subpasses[i].input_references.size(); j++) {
  3364. _attachment_reference_to_vk(p_subpasses[i].input_references[j], &vk_subpass_input_attachments[j]);
  3365. }
  3366. VkAttachmentReference2KHR *vk_subpass_color_attachments = ALLOCA_ARRAY(VkAttachmentReference2KHR, p_subpasses[i].color_references.size());
  3367. for (uint32_t j = 0; j < p_subpasses[i].color_references.size(); j++) {
  3368. _attachment_reference_to_vk(p_subpasses[i].color_references[j], &vk_subpass_color_attachments[j]);
  3369. }
  3370. VkAttachmentReference2KHR *vk_subpass_resolve_attachments = ALLOCA_ARRAY(VkAttachmentReference2KHR, p_subpasses[i].resolve_references.size());
  3371. for (uint32_t j = 0; j < p_subpasses[i].resolve_references.size(); j++) {
  3372. _attachment_reference_to_vk(p_subpasses[i].resolve_references[j], &vk_subpass_resolve_attachments[j]);
  3373. }
  3374. VkAttachmentReference2KHR *vk_subpass_depth_stencil_attachment = nullptr;
  3375. if (p_subpasses[i].depth_stencil_reference.attachment != AttachmentReference::UNUSED) {
  3376. vk_subpass_depth_stencil_attachment = ALLOCA_SINGLE(VkAttachmentReference2KHR);
  3377. _attachment_reference_to_vk(p_subpasses[i].depth_stencil_reference, vk_subpass_depth_stencil_attachment);
  3378. }
  3379. vk_subpasses[i] = {};
  3380. vk_subpasses[i].sType = VK_STRUCTURE_TYPE_SUBPASS_DESCRIPTION_2_KHR;
  3381. vk_subpasses[i].pipelineBindPoint = VK_PIPELINE_BIND_POINT_GRAPHICS;
  3382. vk_subpasses[i].viewMask = p_view_count == 1 ? 0 : view_mask;
  3383. vk_subpasses[i].inputAttachmentCount = p_subpasses[i].input_references.size();
  3384. vk_subpasses[i].pInputAttachments = vk_subpass_input_attachments;
  3385. vk_subpasses[i].colorAttachmentCount = p_subpasses[i].color_references.size();
  3386. vk_subpasses[i].pColorAttachments = vk_subpass_color_attachments;
  3387. vk_subpasses[i].pResolveAttachments = vk_subpass_resolve_attachments;
  3388. vk_subpasses[i].pDepthStencilAttachment = vk_subpass_depth_stencil_attachment;
  3389. vk_subpasses[i].preserveAttachmentCount = p_subpasses[i].preserve_attachments.size();
  3390. vk_subpasses[i].pPreserveAttachments = p_subpasses[i].preserve_attachments.ptr();
  3391. // VRS.
  3392. if (vrs_capabilities.attachment_vrs_supported && p_subpasses[i].vrs_reference.attachment != AttachmentReference::UNUSED) {
  3393. VkAttachmentReference2KHR *vk_subpass_vrs_attachment = ALLOCA_SINGLE(VkAttachmentReference2KHR);
  3394. *vk_subpass_vrs_attachment = {};
  3395. vk_subpass_vrs_attachment->sType = VK_STRUCTURE_TYPE_ATTACHMENT_REFERENCE_2_KHR;
  3396. vk_subpass_vrs_attachment->attachment = p_subpasses[i].vrs_reference.attachment;
  3397. vk_subpass_vrs_attachment->layout = VK_IMAGE_LAYOUT_FRAGMENT_SHADING_RATE_ATTACHMENT_OPTIMAL_KHR;
  3398. VkFragmentShadingRateAttachmentInfoKHR *vk_vrs_info = ALLOCA_SINGLE(VkFragmentShadingRateAttachmentInfoKHR);
  3399. *vk_vrs_info = {};
  3400. vk_vrs_info->sType = VK_STRUCTURE_TYPE_FRAGMENT_SHADING_RATE_ATTACHMENT_INFO_KHR;
  3401. vk_vrs_info->pFragmentShadingRateAttachment = vk_subpass_vrs_attachment;
  3402. vk_vrs_info->shadingRateAttachmentTexelSize.width = vrs_capabilities.texel_size.x;
  3403. vk_vrs_info->shadingRateAttachmentTexelSize.height = vrs_capabilities.texel_size.y;
  3404. vk_subpasses[i].pNext = vk_vrs_info;
  3405. }
  3406. }
  3407. VkSubpassDependency2KHR *vk_subpass_dependencies = ALLOCA_ARRAY(VkSubpassDependency2KHR, p_subpass_dependencies.size());
  3408. for (uint32_t i = 0; i < p_subpass_dependencies.size(); i++) {
  3409. vk_subpass_dependencies[i] = {};
  3410. vk_subpass_dependencies[i].sType = VK_STRUCTURE_TYPE_SUBPASS_DEPENDENCY_2;
  3411. vk_subpass_dependencies[i].srcSubpass = p_subpass_dependencies[i].src_subpass;
  3412. vk_subpass_dependencies[i].dstSubpass = p_subpass_dependencies[i].dst_subpass;
  3413. vk_subpass_dependencies[i].srcStageMask = (VkPipelineStageFlags)p_subpass_dependencies[i].src_stages;
  3414. vk_subpass_dependencies[i].dstStageMask = (VkPipelineStageFlags)p_subpass_dependencies[i].dst_stages;
  3415. vk_subpass_dependencies[i].srcAccessMask = (VkAccessFlags)p_subpass_dependencies[i].src_access;
  3416. vk_subpass_dependencies[i].dstAccessMask = (VkAccessFlags)p_subpass_dependencies[i].dst_access;
  3417. }
  3418. VkRenderPassCreateInfo2KHR create_info = {};
  3419. create_info.sType = VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO_2_KHR;
  3420. create_info.attachmentCount = p_attachments.size();
  3421. create_info.pAttachments = vk_attachments;
  3422. create_info.subpassCount = p_subpasses.size();
  3423. create_info.pSubpasses = vk_subpasses;
  3424. create_info.dependencyCount = p_subpass_dependencies.size();
  3425. create_info.pDependencies = vk_subpass_dependencies;
  3426. create_info.correlatedViewMaskCount = p_view_count == 1 ? 0 : 1;
  3427. create_info.pCorrelatedViewMasks = p_view_count == 1 ? nullptr : &correlation_mask;
  3428. // Multiview.
  3429. if (p_view_count > 1 && device_functions.CreateRenderPass2KHR == nullptr) {
  3430. // This is only required when not using vkCreateRenderPass2.
  3431. // We add it if vkCreateRenderPass2KHR is not supported,
  3432. // resulting this in being passed to our vkCreateRenderPass fallback.
  3433. uint32_t *vk_view_masks = ALLOCA_ARRAY(uint32_t, p_subpasses.size());
  3434. for (uint32_t i = 0; i < p_subpasses.size(); i++) {
  3435. vk_view_masks[i] = view_mask;
  3436. }
  3437. VkRenderPassMultiviewCreateInfo *multiview_create_info = ALLOCA_SINGLE(VkRenderPassMultiviewCreateInfo);
  3438. *multiview_create_info = {};
  3439. multiview_create_info->sType = VK_STRUCTURE_TYPE_RENDER_PASS_MULTIVIEW_CREATE_INFO;
  3440. multiview_create_info->subpassCount = p_subpasses.size();
  3441. multiview_create_info->pViewMasks = vk_view_masks;
  3442. multiview_create_info->correlationMaskCount = 1;
  3443. multiview_create_info->pCorrelationMasks = &correlation_mask;
  3444. create_info.pNext = multiview_create_info;
  3445. }
  3446. VkRenderPass vk_render_pass = VK_NULL_HANDLE;
  3447. VkResult res = _create_render_pass(vk_device, &create_info, nullptr, &vk_render_pass);
  3448. ERR_FAIL_COND_V_MSG(res, RenderPassID(), "vkCreateRenderPass2KHR failed with error " + itos(res) + ".");
  3449. return RenderPassID(vk_render_pass);
  3450. }
  3451. void RenderingDeviceDriverVulkan::render_pass_free(RenderPassID p_render_pass) {
  3452. vkDestroyRenderPass(vk_device, (VkRenderPass)p_render_pass.id, nullptr);
  3453. }
  3454. // ----- COMMANDS -----
  3455. static_assert(ARRAYS_COMPATIBLE_FIELDWISE(RDD::RenderPassClearValue, VkClearValue));
  3456. void RenderingDeviceDriverVulkan::command_begin_render_pass(CommandBufferID p_cmd_buffer, RenderPassID p_render_pass, FramebufferID p_framebuffer, CommandBufferType p_cmd_buffer_type, const Rect2i &p_rect, VectorView<RenderPassClearValue> p_clear_values) {
  3457. VkRenderPassBeginInfo render_pass_begin = {};
  3458. render_pass_begin.sType = VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO;
  3459. render_pass_begin.renderPass = (VkRenderPass)p_render_pass.id;
  3460. render_pass_begin.framebuffer = (VkFramebuffer)p_framebuffer.id;
  3461. render_pass_begin.renderArea.offset.x = p_rect.position.x;
  3462. render_pass_begin.renderArea.offset.y = p_rect.position.y;
  3463. render_pass_begin.renderArea.extent.width = p_rect.size.x;
  3464. render_pass_begin.renderArea.extent.height = p_rect.size.y;
  3465. render_pass_begin.clearValueCount = p_clear_values.size();
  3466. render_pass_begin.pClearValues = (const VkClearValue *)p_clear_values.ptr();
  3467. VkSubpassContents vk_subpass_contents = p_cmd_buffer_type == COMMAND_BUFFER_TYPE_PRIMARY ? VK_SUBPASS_CONTENTS_INLINE : VK_SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS;
  3468. vkCmdBeginRenderPass((VkCommandBuffer)p_cmd_buffer.id, &render_pass_begin, vk_subpass_contents);
  3469. #if PRINT_NATIVE_COMMANDS
  3470. print_line(vformat("vkCmdBeginRenderPass Pass 0x%uX Framebuffer 0x%uX", p_render_pass.id, p_framebuffer.id));
  3471. #endif
  3472. }
  3473. void RenderingDeviceDriverVulkan::command_end_render_pass(CommandBufferID p_cmd_buffer) {
  3474. vkCmdEndRenderPass((VkCommandBuffer)p_cmd_buffer.id);
  3475. #if PRINT_NATIVE_COMMANDS
  3476. print_line("vkCmdEndRenderPass");
  3477. #endif
  3478. }
  3479. void RenderingDeviceDriverVulkan::command_next_render_subpass(CommandBufferID p_cmd_buffer, CommandBufferType p_cmd_buffer_type) {
  3480. VkSubpassContents vk_subpass_contents = p_cmd_buffer_type == COMMAND_BUFFER_TYPE_PRIMARY ? VK_SUBPASS_CONTENTS_INLINE : VK_SUBPASS_CONTENTS_SECONDARY_COMMAND_BUFFERS;
  3481. vkCmdNextSubpass((VkCommandBuffer)p_cmd_buffer.id, vk_subpass_contents);
  3482. }
  3483. void RenderingDeviceDriverVulkan::command_render_set_viewport(CommandBufferID p_cmd_buffer, VectorView<Rect2i> p_viewports) {
  3484. VkViewport *vk_viewports = ALLOCA_ARRAY(VkViewport, p_viewports.size());
  3485. for (uint32_t i = 0; i < p_viewports.size(); i++) {
  3486. vk_viewports[i] = {};
  3487. vk_viewports[i].x = p_viewports[i].position.x;
  3488. vk_viewports[i].y = p_viewports[i].position.y;
  3489. vk_viewports[i].width = p_viewports[i].size.x;
  3490. vk_viewports[i].height = p_viewports[i].size.y;
  3491. vk_viewports[i].minDepth = 0.0f;
  3492. vk_viewports[i].maxDepth = 1.0f;
  3493. }
  3494. vkCmdSetViewport((VkCommandBuffer)p_cmd_buffer.id, 0, p_viewports.size(), vk_viewports);
  3495. }
  3496. void RenderingDeviceDriverVulkan::command_render_set_scissor(CommandBufferID p_cmd_buffer, VectorView<Rect2i> p_scissors) {
  3497. vkCmdSetScissor((VkCommandBuffer)p_cmd_buffer.id, 0, p_scissors.size(), (VkRect2D *)p_scissors.ptr());
  3498. }
  3499. void RenderingDeviceDriverVulkan::command_render_clear_attachments(CommandBufferID p_cmd_buffer, VectorView<AttachmentClear> p_attachment_clears, VectorView<Rect2i> p_rects) {
  3500. VkClearAttachment *vk_clears = ALLOCA_ARRAY(VkClearAttachment, p_attachment_clears.size());
  3501. for (uint32_t i = 0; i < p_attachment_clears.size(); i++) {
  3502. vk_clears[i] = {};
  3503. memcpy(&vk_clears[i].clearValue, &p_attachment_clears[i].value, sizeof(VkClearValue));
  3504. vk_clears[i].colorAttachment = p_attachment_clears[i].color_attachment;
  3505. vk_clears[i].aspectMask = p_attachment_clears[i].aspect;
  3506. }
  3507. VkClearRect *vk_rects = ALLOCA_ARRAY(VkClearRect, p_rects.size());
  3508. for (uint32_t i = 0; i < p_rects.size(); i++) {
  3509. vk_rects[i] = {};
  3510. vk_rects[i].rect.offset.x = p_rects[i].position.x;
  3511. vk_rects[i].rect.offset.y = p_rects[i].position.y;
  3512. vk_rects[i].rect.extent.width = p_rects[i].size.x;
  3513. vk_rects[i].rect.extent.height = p_rects[i].size.y;
  3514. vk_rects[i].baseArrayLayer = 0;
  3515. vk_rects[i].layerCount = 1;
  3516. }
  3517. vkCmdClearAttachments((VkCommandBuffer)p_cmd_buffer.id, p_attachment_clears.size(), vk_clears, p_rects.size(), vk_rects);
  3518. }
  3519. void RenderingDeviceDriverVulkan::command_bind_render_pipeline(CommandBufferID p_cmd_buffer, PipelineID p_pipeline) {
  3520. vkCmdBindPipeline((VkCommandBuffer)p_cmd_buffer.id, VK_PIPELINE_BIND_POINT_GRAPHICS, (VkPipeline)p_pipeline.id);
  3521. }
  3522. void RenderingDeviceDriverVulkan::command_bind_render_uniform_set(CommandBufferID p_cmd_buffer, UniformSetID p_uniform_set, ShaderID p_shader, uint32_t p_set_index) {
  3523. const ShaderInfo *shader_info = (const ShaderInfo *)p_shader.id;
  3524. const UniformSetInfo *usi = (const UniformSetInfo *)p_uniform_set.id;
  3525. vkCmdBindDescriptorSets((VkCommandBuffer)p_cmd_buffer.id, VK_PIPELINE_BIND_POINT_GRAPHICS, shader_info->vk_pipeline_layout, p_set_index, 1, &usi->vk_descriptor_set, 0, nullptr);
  3526. }
  3527. void RenderingDeviceDriverVulkan::command_render_draw(CommandBufferID p_cmd_buffer, uint32_t p_vertex_count, uint32_t p_instance_count, uint32_t p_base_vertex, uint32_t p_first_instance) {
  3528. vkCmdDraw((VkCommandBuffer)p_cmd_buffer.id, p_vertex_count, p_instance_count, p_base_vertex, p_first_instance);
  3529. }
  3530. void RenderingDeviceDriverVulkan::command_render_draw_indexed(CommandBufferID p_cmd_buffer, uint32_t p_index_count, uint32_t p_instance_count, uint32_t p_first_index, int32_t p_vertex_offset, uint32_t p_first_instance) {
  3531. vkCmdDrawIndexed((VkCommandBuffer)p_cmd_buffer.id, p_index_count, p_instance_count, p_first_index, p_vertex_offset, p_first_instance);
  3532. }
  3533. void RenderingDeviceDriverVulkan::command_render_draw_indexed_indirect(CommandBufferID p_cmd_buffer, BufferID p_indirect_buffer, uint64_t p_offset, uint32_t p_draw_count, uint32_t p_stride) {
  3534. const BufferInfo *buf_info = (const BufferInfo *)p_indirect_buffer.id;
  3535. vkCmdDrawIndexedIndirect((VkCommandBuffer)p_cmd_buffer.id, buf_info->vk_buffer, p_offset, p_draw_count, p_stride);
  3536. }
  3537. void RenderingDeviceDriverVulkan::command_render_draw_indexed_indirect_count(CommandBufferID p_cmd_buffer, BufferID p_indirect_buffer, uint64_t p_offset, BufferID p_count_buffer, uint64_t p_count_buffer_offset, uint32_t p_max_draw_count, uint32_t p_stride) {
  3538. const BufferInfo *indirect_buf_info = (const BufferInfo *)p_indirect_buffer.id;
  3539. const BufferInfo *count_buf_info = (const BufferInfo *)p_count_buffer.id;
  3540. vkCmdDrawIndexedIndirectCount((VkCommandBuffer)p_cmd_buffer.id, indirect_buf_info->vk_buffer, p_offset, count_buf_info->vk_buffer, p_count_buffer_offset, p_max_draw_count, p_stride);
  3541. }
  3542. void RenderingDeviceDriverVulkan::command_render_draw_indirect(CommandBufferID p_cmd_buffer, BufferID p_indirect_buffer, uint64_t p_offset, uint32_t p_draw_count, uint32_t p_stride) {
  3543. const BufferInfo *buf_info = (const BufferInfo *)p_indirect_buffer.id;
  3544. vkCmdDrawIndirect((VkCommandBuffer)p_cmd_buffer.id, buf_info->vk_buffer, p_offset, p_draw_count, p_stride);
  3545. }
  3546. void RenderingDeviceDriverVulkan::command_render_draw_indirect_count(CommandBufferID p_cmd_buffer, BufferID p_indirect_buffer, uint64_t p_offset, BufferID p_count_buffer, uint64_t p_count_buffer_offset, uint32_t p_max_draw_count, uint32_t p_stride) {
  3547. const BufferInfo *indirect_buf_info = (const BufferInfo *)p_indirect_buffer.id;
  3548. const BufferInfo *count_buf_info = (const BufferInfo *)p_count_buffer.id;
  3549. vkCmdDrawIndirectCount((VkCommandBuffer)p_cmd_buffer.id, indirect_buf_info->vk_buffer, p_offset, count_buf_info->vk_buffer, p_count_buffer_offset, p_max_draw_count, p_stride);
  3550. }
  3551. void RenderingDeviceDriverVulkan::command_render_bind_vertex_buffers(CommandBufferID p_cmd_buffer, uint32_t p_binding_count, const BufferID *p_buffers, const uint64_t *p_offsets) {
  3552. VkBuffer *vk_buffers = ALLOCA_ARRAY(VkBuffer, p_binding_count);
  3553. for (uint32_t i = 0; i < p_binding_count; i++) {
  3554. vk_buffers[i] = ((const BufferInfo *)p_buffers[i].id)->vk_buffer;
  3555. }
  3556. vkCmdBindVertexBuffers((VkCommandBuffer)p_cmd_buffer.id, 0, p_binding_count, vk_buffers, p_offsets);
  3557. }
  3558. void RenderingDeviceDriverVulkan::command_render_bind_index_buffer(CommandBufferID p_cmd_buffer, BufferID p_buffer, IndexBufferFormat p_format, uint64_t p_offset) {
  3559. const BufferInfo *buf_info = (const BufferInfo *)p_buffer.id;
  3560. vkCmdBindIndexBuffer((VkCommandBuffer)p_cmd_buffer.id, buf_info->vk_buffer, p_offset, p_format == INDEX_BUFFER_FORMAT_UINT16 ? VK_INDEX_TYPE_UINT16 : VK_INDEX_TYPE_UINT32);
  3561. }
  3562. void RenderingDeviceDriverVulkan::command_render_set_blend_constants(CommandBufferID p_cmd_buffer, const Color &p_constants) {
  3563. vkCmdSetBlendConstants((VkCommandBuffer)p_cmd_buffer.id, p_constants.components);
  3564. }
  3565. void RenderingDeviceDriverVulkan::command_render_set_line_width(CommandBufferID p_cmd_buffer, float p_width) {
  3566. vkCmdSetLineWidth((VkCommandBuffer)p_cmd_buffer.id, p_width);
  3567. }
  3568. // ----- PIPELINE -----
  3569. static const VkPrimitiveTopology RD_TO_VK_PRIMITIVE[RDD::RENDER_PRIMITIVE_MAX] = {
  3570. VK_PRIMITIVE_TOPOLOGY_POINT_LIST,
  3571. VK_PRIMITIVE_TOPOLOGY_LINE_LIST,
  3572. VK_PRIMITIVE_TOPOLOGY_LINE_LIST_WITH_ADJACENCY,
  3573. VK_PRIMITIVE_TOPOLOGY_LINE_STRIP,
  3574. VK_PRIMITIVE_TOPOLOGY_LINE_STRIP_WITH_ADJACENCY,
  3575. VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST,
  3576. VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST_WITH_ADJACENCY,
  3577. VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP,
  3578. VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP_WITH_ADJACENCY,
  3579. VK_PRIMITIVE_TOPOLOGY_TRIANGLE_STRIP,
  3580. VK_PRIMITIVE_TOPOLOGY_PATCH_LIST,
  3581. };
  3582. // RDD::PolygonCullMode == VkCullModeFlagBits.
  3583. static_assert(ENUM_MEMBERS_EQUAL(RDD::POLYGON_CULL_DISABLED, VK_CULL_MODE_NONE));
  3584. static_assert(ENUM_MEMBERS_EQUAL(RDD::POLYGON_CULL_FRONT, VK_CULL_MODE_FRONT_BIT));
  3585. static_assert(ENUM_MEMBERS_EQUAL(RDD::POLYGON_CULL_BACK, VK_CULL_MODE_BACK_BIT));
  3586. // RDD::StencilOperation == VkStencilOp.
  3587. static_assert(ENUM_MEMBERS_EQUAL(RDD::STENCIL_OP_KEEP, VK_STENCIL_OP_KEEP));
  3588. static_assert(ENUM_MEMBERS_EQUAL(RDD::STENCIL_OP_ZERO, VK_STENCIL_OP_ZERO));
  3589. static_assert(ENUM_MEMBERS_EQUAL(RDD::STENCIL_OP_REPLACE, VK_STENCIL_OP_REPLACE));
  3590. static_assert(ENUM_MEMBERS_EQUAL(RDD::STENCIL_OP_INCREMENT_AND_CLAMP, VK_STENCIL_OP_INCREMENT_AND_CLAMP));
  3591. static_assert(ENUM_MEMBERS_EQUAL(RDD::STENCIL_OP_DECREMENT_AND_CLAMP, VK_STENCIL_OP_DECREMENT_AND_CLAMP));
  3592. static_assert(ENUM_MEMBERS_EQUAL(RDD::STENCIL_OP_INVERT, VK_STENCIL_OP_INVERT));
  3593. static_assert(ENUM_MEMBERS_EQUAL(RDD::STENCIL_OP_INCREMENT_AND_WRAP, VK_STENCIL_OP_INCREMENT_AND_WRAP));
  3594. static_assert(ENUM_MEMBERS_EQUAL(RDD::STENCIL_OP_DECREMENT_AND_WRAP, VK_STENCIL_OP_DECREMENT_AND_WRAP));
  3595. // RDD::LogicOperation == VkLogicOp.
  3596. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_CLEAR, VK_LOGIC_OP_CLEAR));
  3597. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_AND, VK_LOGIC_OP_AND));
  3598. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_AND_REVERSE, VK_LOGIC_OP_AND_REVERSE));
  3599. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_COPY, VK_LOGIC_OP_COPY));
  3600. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_AND_INVERTED, VK_LOGIC_OP_AND_INVERTED));
  3601. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_NO_OP, VK_LOGIC_OP_NO_OP));
  3602. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_XOR, VK_LOGIC_OP_XOR));
  3603. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_OR, VK_LOGIC_OP_OR));
  3604. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_NOR, VK_LOGIC_OP_NOR));
  3605. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_EQUIVALENT, VK_LOGIC_OP_EQUIVALENT));
  3606. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_INVERT, VK_LOGIC_OP_INVERT));
  3607. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_OR_REVERSE, VK_LOGIC_OP_OR_REVERSE));
  3608. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_COPY_INVERTED, VK_LOGIC_OP_COPY_INVERTED));
  3609. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_OR_INVERTED, VK_LOGIC_OP_OR_INVERTED));
  3610. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_NAND, VK_LOGIC_OP_NAND));
  3611. static_assert(ENUM_MEMBERS_EQUAL(RDD::LOGIC_OP_SET, VK_LOGIC_OP_SET));
  3612. // RDD::BlendFactor == VkBlendFactor.
  3613. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ZERO, VK_BLEND_FACTOR_ZERO));
  3614. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ONE, VK_BLEND_FACTOR_ONE));
  3615. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_SRC_COLOR, VK_BLEND_FACTOR_SRC_COLOR));
  3616. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ONE_MINUS_SRC_COLOR, VK_BLEND_FACTOR_ONE_MINUS_SRC_COLOR));
  3617. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_DST_COLOR, VK_BLEND_FACTOR_DST_COLOR));
  3618. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ONE_MINUS_DST_COLOR, VK_BLEND_FACTOR_ONE_MINUS_DST_COLOR));
  3619. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_SRC_ALPHA, VK_BLEND_FACTOR_SRC_ALPHA));
  3620. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ONE_MINUS_SRC_ALPHA, VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA));
  3621. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_DST_ALPHA, VK_BLEND_FACTOR_DST_ALPHA));
  3622. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ONE_MINUS_DST_ALPHA, VK_BLEND_FACTOR_ONE_MINUS_DST_ALPHA));
  3623. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_CONSTANT_COLOR, VK_BLEND_FACTOR_CONSTANT_COLOR));
  3624. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR, VK_BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR));
  3625. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_CONSTANT_ALPHA, VK_BLEND_FACTOR_CONSTANT_ALPHA));
  3626. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA, VK_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA));
  3627. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_SRC_ALPHA_SATURATE, VK_BLEND_FACTOR_SRC_ALPHA_SATURATE));
  3628. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_SRC1_COLOR, VK_BLEND_FACTOR_SRC1_COLOR));
  3629. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ONE_MINUS_SRC1_COLOR, VK_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR));
  3630. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_SRC1_ALPHA, VK_BLEND_FACTOR_SRC1_ALPHA));
  3631. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA, VK_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA));
  3632. // RDD::BlendOperation == VkBlendOp.
  3633. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_OP_ADD, VK_BLEND_OP_ADD));
  3634. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_OP_SUBTRACT, VK_BLEND_OP_SUBTRACT));
  3635. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_OP_REVERSE_SUBTRACT, VK_BLEND_OP_REVERSE_SUBTRACT));
  3636. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_OP_MINIMUM, VK_BLEND_OP_MIN));
  3637. static_assert(ENUM_MEMBERS_EQUAL(RDD::BLEND_OP_MAXIMUM, VK_BLEND_OP_MAX));
  3638. RDD::PipelineID RenderingDeviceDriverVulkan::render_pipeline_create(
  3639. ShaderID p_shader,
  3640. VertexFormatID p_vertex_format,
  3641. RenderPrimitive p_render_primitive,
  3642. PipelineRasterizationState p_rasterization_state,
  3643. PipelineMultisampleState p_multisample_state,
  3644. PipelineDepthStencilState p_depth_stencil_state,
  3645. PipelineColorBlendState p_blend_state,
  3646. VectorView<int32_t> p_color_attachments,
  3647. BitField<PipelineDynamicStateFlags> p_dynamic_state,
  3648. RenderPassID p_render_pass,
  3649. uint32_t p_render_subpass,
  3650. VectorView<PipelineSpecializationConstant> p_specialization_constants) {
  3651. // Vertex.
  3652. const VkPipelineVertexInputStateCreateInfo *vertex_input_state_create_info = nullptr;
  3653. if (p_vertex_format.id) {
  3654. const VertexFormatInfo *vf_info = (const VertexFormatInfo *)p_vertex_format.id;
  3655. vertex_input_state_create_info = &vf_info->vk_create_info;
  3656. } else {
  3657. VkPipelineVertexInputStateCreateInfo *null_vertex_input_state = ALLOCA_SINGLE(VkPipelineVertexInputStateCreateInfo);
  3658. *null_vertex_input_state = {};
  3659. null_vertex_input_state->sType = VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO;
  3660. vertex_input_state_create_info = null_vertex_input_state;
  3661. }
  3662. // Input assembly.
  3663. VkPipelineInputAssemblyStateCreateInfo input_assembly_create_info = {};
  3664. input_assembly_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO;
  3665. input_assembly_create_info.topology = RD_TO_VK_PRIMITIVE[p_render_primitive];
  3666. input_assembly_create_info.primitiveRestartEnable = (p_render_primitive == RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX);
  3667. // Tessellation.
  3668. VkPipelineTessellationStateCreateInfo tessellation_create_info = {};
  3669. tessellation_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_TESSELLATION_STATE_CREATE_INFO;
  3670. ERR_FAIL_COND_V(physical_device_properties.limits.maxTessellationPatchSize > 0 && (p_rasterization_state.patch_control_points < 1 || p_rasterization_state.patch_control_points > physical_device_properties.limits.maxTessellationPatchSize), PipelineID());
  3671. tessellation_create_info.patchControlPoints = p_rasterization_state.patch_control_points;
  3672. // Viewport.
  3673. VkPipelineViewportStateCreateInfo viewport_state_create_info = {};
  3674. viewport_state_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO;
  3675. viewport_state_create_info.viewportCount = 1; // If VR extensions are supported at some point, this will have to be customizable in the framebuffer format.
  3676. viewport_state_create_info.scissorCount = 1;
  3677. // Rasterization.
  3678. VkPipelineRasterizationStateCreateInfo rasterization_state_create_info = {};
  3679. rasterization_state_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO;
  3680. rasterization_state_create_info.depthClampEnable = p_rasterization_state.enable_depth_clamp;
  3681. rasterization_state_create_info.rasterizerDiscardEnable = p_rasterization_state.discard_primitives;
  3682. rasterization_state_create_info.polygonMode = p_rasterization_state.wireframe ? VK_POLYGON_MODE_LINE : VK_POLYGON_MODE_FILL;
  3683. rasterization_state_create_info.cullMode = (PolygonCullMode)p_rasterization_state.cull_mode;
  3684. rasterization_state_create_info.frontFace = (p_rasterization_state.front_face == POLYGON_FRONT_FACE_CLOCKWISE ? VK_FRONT_FACE_CLOCKWISE : VK_FRONT_FACE_COUNTER_CLOCKWISE);
  3685. rasterization_state_create_info.depthBiasEnable = p_rasterization_state.depth_bias_enabled;
  3686. rasterization_state_create_info.depthBiasConstantFactor = p_rasterization_state.depth_bias_constant_factor;
  3687. rasterization_state_create_info.depthBiasClamp = p_rasterization_state.depth_bias_clamp;
  3688. rasterization_state_create_info.depthBiasSlopeFactor = p_rasterization_state.depth_bias_slope_factor;
  3689. rasterization_state_create_info.lineWidth = p_rasterization_state.line_width;
  3690. // Multisample.
  3691. VkPipelineMultisampleStateCreateInfo multisample_state_create_info = {};
  3692. multisample_state_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO;
  3693. multisample_state_create_info.rasterizationSamples = _ensure_supported_sample_count(p_multisample_state.sample_count);
  3694. multisample_state_create_info.sampleShadingEnable = p_multisample_state.enable_sample_shading;
  3695. multisample_state_create_info.minSampleShading = p_multisample_state.min_sample_shading;
  3696. if (p_multisample_state.sample_mask.size()) {
  3697. static_assert(ARRAYS_COMPATIBLE(uint32_t, VkSampleMask));
  3698. multisample_state_create_info.pSampleMask = p_multisample_state.sample_mask.ptr();
  3699. } else {
  3700. multisample_state_create_info.pSampleMask = nullptr;
  3701. }
  3702. multisample_state_create_info.alphaToCoverageEnable = p_multisample_state.enable_alpha_to_coverage;
  3703. multisample_state_create_info.alphaToOneEnable = p_multisample_state.enable_alpha_to_one;
  3704. // Depth stencil.
  3705. VkPipelineDepthStencilStateCreateInfo depth_stencil_state_create_info = {};
  3706. depth_stencil_state_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO;
  3707. depth_stencil_state_create_info.depthTestEnable = p_depth_stencil_state.enable_depth_test;
  3708. depth_stencil_state_create_info.depthWriteEnable = p_depth_stencil_state.enable_depth_write;
  3709. depth_stencil_state_create_info.depthCompareOp = (VkCompareOp)p_depth_stencil_state.depth_compare_operator;
  3710. depth_stencil_state_create_info.depthBoundsTestEnable = p_depth_stencil_state.enable_depth_range;
  3711. depth_stencil_state_create_info.stencilTestEnable = p_depth_stencil_state.enable_stencil;
  3712. depth_stencil_state_create_info.front.failOp = (VkStencilOp)p_depth_stencil_state.front_op.fail;
  3713. depth_stencil_state_create_info.front.passOp = (VkStencilOp)p_depth_stencil_state.front_op.pass;
  3714. depth_stencil_state_create_info.front.depthFailOp = (VkStencilOp)p_depth_stencil_state.front_op.depth_fail;
  3715. depth_stencil_state_create_info.front.compareOp = (VkCompareOp)p_depth_stencil_state.front_op.compare;
  3716. depth_stencil_state_create_info.front.compareMask = p_depth_stencil_state.front_op.compare_mask;
  3717. depth_stencil_state_create_info.front.writeMask = p_depth_stencil_state.front_op.write_mask;
  3718. depth_stencil_state_create_info.front.reference = p_depth_stencil_state.front_op.reference;
  3719. depth_stencil_state_create_info.back.failOp = (VkStencilOp)p_depth_stencil_state.back_op.fail;
  3720. depth_stencil_state_create_info.back.passOp = (VkStencilOp)p_depth_stencil_state.back_op.pass;
  3721. depth_stencil_state_create_info.back.depthFailOp = (VkStencilOp)p_depth_stencil_state.back_op.depth_fail;
  3722. depth_stencil_state_create_info.back.compareOp = (VkCompareOp)p_depth_stencil_state.back_op.compare;
  3723. depth_stencil_state_create_info.back.compareMask = p_depth_stencil_state.back_op.compare_mask;
  3724. depth_stencil_state_create_info.back.writeMask = p_depth_stencil_state.back_op.write_mask;
  3725. depth_stencil_state_create_info.back.reference = p_depth_stencil_state.back_op.reference;
  3726. depth_stencil_state_create_info.minDepthBounds = p_depth_stencil_state.depth_range_min;
  3727. depth_stencil_state_create_info.maxDepthBounds = p_depth_stencil_state.depth_range_max;
  3728. // Blend state.
  3729. VkPipelineColorBlendStateCreateInfo color_blend_state_create_info = {};
  3730. color_blend_state_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO;
  3731. color_blend_state_create_info.logicOpEnable = p_blend_state.enable_logic_op;
  3732. color_blend_state_create_info.logicOp = (VkLogicOp)p_blend_state.logic_op;
  3733. VkPipelineColorBlendAttachmentState *vk_attachment_states = ALLOCA_ARRAY(VkPipelineColorBlendAttachmentState, p_color_attachments.size());
  3734. {
  3735. for (uint32_t i = 0; i < p_color_attachments.size(); i++) {
  3736. vk_attachment_states[i] = {};
  3737. if (p_color_attachments[i] != ATTACHMENT_UNUSED) {
  3738. vk_attachment_states[i].blendEnable = p_blend_state.attachments[i].enable_blend;
  3739. vk_attachment_states[i].srcColorBlendFactor = (VkBlendFactor)p_blend_state.attachments[i].src_color_blend_factor;
  3740. vk_attachment_states[i].dstColorBlendFactor = (VkBlendFactor)p_blend_state.attachments[i].dst_color_blend_factor;
  3741. vk_attachment_states[i].colorBlendOp = (VkBlendOp)p_blend_state.attachments[i].color_blend_op;
  3742. vk_attachment_states[i].srcAlphaBlendFactor = (VkBlendFactor)p_blend_state.attachments[i].src_alpha_blend_factor;
  3743. vk_attachment_states[i].dstAlphaBlendFactor = (VkBlendFactor)p_blend_state.attachments[i].dst_alpha_blend_factor;
  3744. vk_attachment_states[i].alphaBlendOp = (VkBlendOp)p_blend_state.attachments[i].alpha_blend_op;
  3745. if (p_blend_state.attachments[i].write_r) {
  3746. vk_attachment_states[i].colorWriteMask |= VK_COLOR_COMPONENT_R_BIT;
  3747. }
  3748. if (p_blend_state.attachments[i].write_g) {
  3749. vk_attachment_states[i].colorWriteMask |= VK_COLOR_COMPONENT_G_BIT;
  3750. }
  3751. if (p_blend_state.attachments[i].write_b) {
  3752. vk_attachment_states[i].colorWriteMask |= VK_COLOR_COMPONENT_B_BIT;
  3753. }
  3754. if (p_blend_state.attachments[i].write_a) {
  3755. vk_attachment_states[i].colorWriteMask |= VK_COLOR_COMPONENT_A_BIT;
  3756. }
  3757. }
  3758. }
  3759. }
  3760. color_blend_state_create_info.attachmentCount = p_color_attachments.size();
  3761. color_blend_state_create_info.pAttachments = vk_attachment_states;
  3762. color_blend_state_create_info.blendConstants[0] = p_blend_state.blend_constant.r;
  3763. color_blend_state_create_info.blendConstants[1] = p_blend_state.blend_constant.g;
  3764. color_blend_state_create_info.blendConstants[2] = p_blend_state.blend_constant.b;
  3765. color_blend_state_create_info.blendConstants[3] = p_blend_state.blend_constant.a;
  3766. // Dynamic state.
  3767. VkPipelineDynamicStateCreateInfo dynamic_state_create_info = {};
  3768. dynamic_state_create_info.sType = VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO;
  3769. static const uint32_t MAX_DYN_STATE_COUNT = 9;
  3770. VkDynamicState *vk_dynamic_states = ALLOCA_ARRAY(VkDynamicState, MAX_DYN_STATE_COUNT);
  3771. uint32_t vk_dynamic_states_count = 0;
  3772. vk_dynamic_states[vk_dynamic_states_count] = VK_DYNAMIC_STATE_VIEWPORT; // Viewport and scissor are always dynamic.
  3773. vk_dynamic_states_count++;
  3774. vk_dynamic_states[vk_dynamic_states_count] = VK_DYNAMIC_STATE_SCISSOR;
  3775. vk_dynamic_states_count++;
  3776. if (p_dynamic_state.has_flag(DYNAMIC_STATE_LINE_WIDTH)) {
  3777. vk_dynamic_states[vk_dynamic_states_count] = VK_DYNAMIC_STATE_LINE_WIDTH;
  3778. vk_dynamic_states_count++;
  3779. }
  3780. if (p_dynamic_state.has_flag(DYNAMIC_STATE_DEPTH_BIAS)) {
  3781. vk_dynamic_states[vk_dynamic_states_count] = VK_DYNAMIC_STATE_DEPTH_BIAS;
  3782. vk_dynamic_states_count++;
  3783. }
  3784. if (p_dynamic_state.has_flag(DYNAMIC_STATE_BLEND_CONSTANTS)) {
  3785. vk_dynamic_states[vk_dynamic_states_count] = VK_DYNAMIC_STATE_BLEND_CONSTANTS;
  3786. vk_dynamic_states_count++;
  3787. }
  3788. if (p_dynamic_state.has_flag(DYNAMIC_STATE_DEPTH_BOUNDS)) {
  3789. vk_dynamic_states[vk_dynamic_states_count] = VK_DYNAMIC_STATE_DEPTH_BOUNDS;
  3790. vk_dynamic_states_count++;
  3791. }
  3792. if (p_dynamic_state.has_flag(DYNAMIC_STATE_STENCIL_COMPARE_MASK)) {
  3793. vk_dynamic_states[vk_dynamic_states_count] = VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK;
  3794. vk_dynamic_states_count++;
  3795. }
  3796. if (p_dynamic_state.has_flag(DYNAMIC_STATE_STENCIL_WRITE_MASK)) {
  3797. vk_dynamic_states[vk_dynamic_states_count] = VK_DYNAMIC_STATE_STENCIL_WRITE_MASK;
  3798. vk_dynamic_states_count++;
  3799. }
  3800. if (p_dynamic_state.has_flag(DYNAMIC_STATE_STENCIL_REFERENCE)) {
  3801. vk_dynamic_states[vk_dynamic_states_count] = VK_DYNAMIC_STATE_STENCIL_REFERENCE;
  3802. vk_dynamic_states_count++;
  3803. }
  3804. DEV_ASSERT(vk_dynamic_states_count <= MAX_DYN_STATE_COUNT);
  3805. dynamic_state_create_info.dynamicStateCount = vk_dynamic_states_count;
  3806. dynamic_state_create_info.pDynamicStates = vk_dynamic_states;
  3807. // VRS.
  3808. void *graphics_pipeline_nextptr = nullptr;
  3809. if (vrs_capabilities.attachment_vrs_supported) {
  3810. // If VRS is used, this defines how the different VRS types are combined.
  3811. // combinerOps[0] decides how we use the output of pipeline and primitive (drawcall) VRS.
  3812. // combinerOps[1] decides how we use the output of combinerOps[0] and our attachment VRS.
  3813. VkPipelineFragmentShadingRateStateCreateInfoKHR *vrs_create_info = ALLOCA_SINGLE(VkPipelineFragmentShadingRateStateCreateInfoKHR);
  3814. *vrs_create_info = {};
  3815. vrs_create_info->sType = VK_STRUCTURE_TYPE_PIPELINE_FRAGMENT_SHADING_RATE_STATE_CREATE_INFO_KHR;
  3816. vrs_create_info->fragmentSize = { 4, 4 };
  3817. vrs_create_info->combinerOps[0] = VK_FRAGMENT_SHADING_RATE_COMBINER_OP_KEEP_KHR; // We don't use pipeline/primitive VRS so this really doesn't matter.
  3818. vrs_create_info->combinerOps[1] = VK_FRAGMENT_SHADING_RATE_COMBINER_OP_REPLACE_KHR; // Always use the outcome of attachment VRS if enabled.
  3819. graphics_pipeline_nextptr = vrs_create_info;
  3820. }
  3821. // Finally, pipeline create info.
  3822. const ShaderInfo *shader_info = (const ShaderInfo *)p_shader.id;
  3823. VkGraphicsPipelineCreateInfo pipeline_create_info = {};
  3824. pipeline_create_info.sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO;
  3825. pipeline_create_info.pNext = graphics_pipeline_nextptr;
  3826. pipeline_create_info.stageCount = shader_info->vk_stages_create_info.size();
  3827. VkPipelineShaderStageCreateInfo *vk_pipeline_stages = ALLOCA_ARRAY(VkPipelineShaderStageCreateInfo, shader_info->vk_stages_create_info.size());
  3828. for (uint32_t i = 0; i < shader_info->vk_stages_create_info.size(); i++) {
  3829. vk_pipeline_stages[i] = shader_info->vk_stages_create_info[i];
  3830. if (p_specialization_constants.size()) {
  3831. VkSpecializationMapEntry *specialization_map_entries = ALLOCA_ARRAY(VkSpecializationMapEntry, p_specialization_constants.size());
  3832. for (uint32_t j = 0; j < p_specialization_constants.size(); j++) {
  3833. specialization_map_entries[j] = {};
  3834. specialization_map_entries[j].constantID = p_specialization_constants[j].constant_id;
  3835. specialization_map_entries[j].offset = (const char *)&p_specialization_constants[j].int_value - (const char *)p_specialization_constants.ptr();
  3836. specialization_map_entries[j].size = sizeof(uint32_t);
  3837. }
  3838. VkSpecializationInfo *specialization_info = ALLOCA_SINGLE(VkSpecializationInfo);
  3839. *specialization_info = {};
  3840. specialization_info->dataSize = p_specialization_constants.size() * sizeof(PipelineSpecializationConstant);
  3841. specialization_info->pData = p_specialization_constants.ptr();
  3842. specialization_info->mapEntryCount = p_specialization_constants.size();
  3843. specialization_info->pMapEntries = specialization_map_entries;
  3844. vk_pipeline_stages[i].pSpecializationInfo = specialization_info;
  3845. }
  3846. }
  3847. pipeline_create_info.pStages = vk_pipeline_stages;
  3848. pipeline_create_info.pVertexInputState = vertex_input_state_create_info;
  3849. pipeline_create_info.pInputAssemblyState = &input_assembly_create_info;
  3850. pipeline_create_info.pTessellationState = &tessellation_create_info;
  3851. pipeline_create_info.pViewportState = &viewport_state_create_info;
  3852. pipeline_create_info.pRasterizationState = &rasterization_state_create_info;
  3853. pipeline_create_info.pMultisampleState = &multisample_state_create_info;
  3854. pipeline_create_info.pDepthStencilState = &depth_stencil_state_create_info;
  3855. pipeline_create_info.pColorBlendState = &color_blend_state_create_info;
  3856. pipeline_create_info.pDynamicState = &dynamic_state_create_info;
  3857. pipeline_create_info.layout = shader_info->vk_pipeline_layout;
  3858. pipeline_create_info.renderPass = (VkRenderPass)p_render_pass.id;
  3859. pipeline_create_info.subpass = p_render_subpass;
  3860. // ---
  3861. VkPipeline vk_pipeline = VK_NULL_HANDLE;
  3862. VkResult err = vkCreateGraphicsPipelines(vk_device, pipelines_cache.vk_cache, 1, &pipeline_create_info, nullptr, &vk_pipeline);
  3863. ERR_FAIL_COND_V_MSG(err, PipelineID(), "vkCreateGraphicsPipelines failed with error " + itos(err) + ".");
  3864. return PipelineID(vk_pipeline);
  3865. }
  3866. /*****************/
  3867. /**** COMPUTE ****/
  3868. /*****************/
  3869. // ----- COMMANDS -----
  3870. void RenderingDeviceDriverVulkan::command_bind_compute_pipeline(CommandBufferID p_cmd_buffer, PipelineID p_pipeline) {
  3871. vkCmdBindPipeline((VkCommandBuffer)p_cmd_buffer.id, VK_PIPELINE_BIND_POINT_COMPUTE, (VkPipeline)p_pipeline.id);
  3872. }
  3873. void RenderingDeviceDriverVulkan::command_bind_compute_uniform_set(CommandBufferID p_cmd_buffer, UniformSetID p_uniform_set, ShaderID p_shader, uint32_t p_set_index) {
  3874. const ShaderInfo *shader_info = (const ShaderInfo *)p_shader.id;
  3875. const UniformSetInfo *usi = (const UniformSetInfo *)p_uniform_set.id;
  3876. vkCmdBindDescriptorSets((VkCommandBuffer)p_cmd_buffer.id, VK_PIPELINE_BIND_POINT_COMPUTE, shader_info->vk_pipeline_layout, p_set_index, 1, &usi->vk_descriptor_set, 0, nullptr);
  3877. }
  3878. void RenderingDeviceDriverVulkan::command_compute_dispatch(CommandBufferID p_cmd_buffer, uint32_t p_x_groups, uint32_t p_y_groups, uint32_t p_z_groups) {
  3879. vkCmdDispatch((VkCommandBuffer)p_cmd_buffer.id, p_x_groups, p_y_groups, p_z_groups);
  3880. }
  3881. void RenderingDeviceDriverVulkan::command_compute_dispatch_indirect(CommandBufferID p_cmd_buffer, BufferID p_indirect_buffer, uint64_t p_offset) {
  3882. const BufferInfo *buf_info = (const BufferInfo *)p_indirect_buffer.id;
  3883. vkCmdDispatchIndirect((VkCommandBuffer)p_cmd_buffer.id, buf_info->vk_buffer, p_offset);
  3884. }
  3885. // ----- PIPELINE -----
  3886. RDD::PipelineID RenderingDeviceDriverVulkan::compute_pipeline_create(ShaderID p_shader, VectorView<PipelineSpecializationConstant> p_specialization_constants) {
  3887. const ShaderInfo *shader_info = (const ShaderInfo *)p_shader.id;
  3888. VkComputePipelineCreateInfo pipeline_create_info = {};
  3889. pipeline_create_info.sType = VK_STRUCTURE_TYPE_COMPUTE_PIPELINE_CREATE_INFO;
  3890. pipeline_create_info.stage = shader_info->vk_stages_create_info[0];
  3891. pipeline_create_info.layout = shader_info->vk_pipeline_layout;
  3892. if (p_specialization_constants.size()) {
  3893. VkSpecializationMapEntry *specialization_map_entries = ALLOCA_ARRAY(VkSpecializationMapEntry, p_specialization_constants.size());
  3894. for (uint32_t i = 0; i < p_specialization_constants.size(); i++) {
  3895. specialization_map_entries[i] = {};
  3896. specialization_map_entries[i].constantID = p_specialization_constants[i].constant_id;
  3897. specialization_map_entries[i].offset = (const char *)&p_specialization_constants[i].int_value - (const char *)p_specialization_constants.ptr();
  3898. specialization_map_entries[i].size = sizeof(uint32_t);
  3899. }
  3900. VkSpecializationInfo *specialization_info = ALLOCA_SINGLE(VkSpecializationInfo);
  3901. *specialization_info = {};
  3902. specialization_info->dataSize = p_specialization_constants.size() * sizeof(PipelineSpecializationConstant);
  3903. specialization_info->pData = p_specialization_constants.ptr();
  3904. specialization_info->mapEntryCount = p_specialization_constants.size();
  3905. specialization_info->pMapEntries = specialization_map_entries;
  3906. pipeline_create_info.stage.pSpecializationInfo = specialization_info;
  3907. }
  3908. VkPipeline vk_pipeline = VK_NULL_HANDLE;
  3909. VkResult err = vkCreateComputePipelines(vk_device, pipelines_cache.vk_cache, 1, &pipeline_create_info, nullptr, &vk_pipeline);
  3910. ERR_FAIL_COND_V_MSG(err, PipelineID(), "vkCreateComputePipelines failed with error " + itos(err) + ".");
  3911. return PipelineID(vk_pipeline);
  3912. }
  3913. /*****************/
  3914. /**** QUERIES ****/
  3915. /*****************/
  3916. // ----- TIMESTAMP -----
  3917. RDD::QueryPoolID RenderingDeviceDriverVulkan::timestamp_query_pool_create(uint32_t p_query_count) {
  3918. VkQueryPoolCreateInfo query_pool_create_info = {};
  3919. query_pool_create_info.sType = VK_STRUCTURE_TYPE_QUERY_POOL_CREATE_INFO;
  3920. query_pool_create_info.queryType = VK_QUERY_TYPE_TIMESTAMP;
  3921. query_pool_create_info.queryCount = p_query_count;
  3922. VkQueryPool vk_query_pool = VK_NULL_HANDLE;
  3923. vkCreateQueryPool(vk_device, &query_pool_create_info, nullptr, &vk_query_pool);
  3924. return RDD::QueryPoolID(vk_query_pool);
  3925. }
  3926. void RenderingDeviceDriverVulkan::timestamp_query_pool_free(QueryPoolID p_pool_id) {
  3927. vkDestroyQueryPool(vk_device, (VkQueryPool)p_pool_id.id, nullptr);
  3928. }
  3929. void RenderingDeviceDriverVulkan::timestamp_query_pool_get_results(QueryPoolID p_pool_id, uint32_t p_query_count, uint64_t *r_results) {
  3930. vkGetQueryPoolResults(vk_device, (VkQueryPool)p_pool_id.id, 0, p_query_count, sizeof(uint64_t) * p_query_count, r_results, sizeof(uint64_t), VK_QUERY_RESULT_64_BIT);
  3931. }
  3932. uint64_t RenderingDeviceDriverVulkan::timestamp_query_result_to_time(uint64_t p_result) {
  3933. // This sucks because timestampPeriod multiplier is a float, while the timestamp is 64 bits nanosecs.
  3934. // So, in cases like nvidia which give you enormous numbers and 1 as multiplier, multiplying is next to impossible.
  3935. // Need to do 128 bits fixed point multiplication to get the right value.
  3936. auto mult64to128 = [](uint64_t u, uint64_t v, uint64_t &h, uint64_t &l) {
  3937. uint64_t u1 = (u & 0xffffffff);
  3938. uint64_t v1 = (v & 0xffffffff);
  3939. uint64_t t = (u1 * v1);
  3940. uint64_t w3 = (t & 0xffffffff);
  3941. uint64_t k = (t >> 32);
  3942. u >>= 32;
  3943. t = (u * v1) + k;
  3944. k = (t & 0xffffffff);
  3945. uint64_t w1 = (t >> 32);
  3946. v >>= 32;
  3947. t = (u1 * v) + k;
  3948. k = (t >> 32);
  3949. h = (u * v) + w1 + k;
  3950. l = (t << 32) + w3;
  3951. };
  3952. uint64_t shift_bits = 16;
  3953. uint64_t h = 0, l = 0;
  3954. mult64to128(p_result, uint64_t(double(physical_device_properties.limits.timestampPeriod) * double(1 << shift_bits)), h, l);
  3955. l >>= shift_bits;
  3956. l |= h << (64 - shift_bits);
  3957. return l;
  3958. }
  3959. void RenderingDeviceDriverVulkan::command_timestamp_query_pool_reset(CommandBufferID p_cmd_buffer, QueryPoolID p_pool_id, uint32_t p_query_count) {
  3960. vkCmdResetQueryPool((VkCommandBuffer)p_cmd_buffer.id, (VkQueryPool)p_pool_id.id, 0, p_query_count);
  3961. }
  3962. void RenderingDeviceDriverVulkan::command_timestamp_write(CommandBufferID p_cmd_buffer, QueryPoolID p_pool_id, uint32_t p_index) {
  3963. vkCmdWriteTimestamp((VkCommandBuffer)p_cmd_buffer.id, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, (VkQueryPool)p_pool_id.id, p_index);
  3964. }
  3965. /****************/
  3966. /**** LABELS ****/
  3967. /****************/
  3968. void RenderingDeviceDriverVulkan::command_begin_label(CommandBufferID p_cmd_buffer, const char *p_label_name, const Color &p_color) {
  3969. const RenderingContextDriverVulkan::Functions &functions = context_driver->functions_get();
  3970. VkDebugUtilsLabelEXT label;
  3971. label.sType = VK_STRUCTURE_TYPE_DEBUG_UTILS_LABEL_EXT;
  3972. label.pNext = nullptr;
  3973. label.pLabelName = p_label_name;
  3974. label.color[0] = p_color[0];
  3975. label.color[1] = p_color[1];
  3976. label.color[2] = p_color[2];
  3977. label.color[3] = p_color[3];
  3978. functions.CmdBeginDebugUtilsLabelEXT((VkCommandBuffer)p_cmd_buffer.id, &label);
  3979. }
  3980. void RenderingDeviceDriverVulkan::command_end_label(CommandBufferID p_cmd_buffer) {
  3981. const RenderingContextDriverVulkan::Functions &functions = context_driver->functions_get();
  3982. functions.CmdEndDebugUtilsLabelEXT((VkCommandBuffer)p_cmd_buffer.id);
  3983. }
  3984. /********************/
  3985. /**** SUBMISSION ****/
  3986. /********************/
  3987. void RenderingDeviceDriverVulkan::begin_segment(uint32_t p_frame_index, uint32_t p_frames_drawn) {
  3988. // Per-frame segments are not required in Vulkan.
  3989. }
  3990. void RenderingDeviceDriverVulkan::end_segment() {
  3991. // Per-frame segments are not required in Vulkan.
  3992. }
  3993. /**************/
  3994. /**** MISC ****/
  3995. /**************/
  3996. void RenderingDeviceDriverVulkan::set_object_name(ObjectType p_type, ID p_driver_id, const String &p_name) {
  3997. switch (p_type) {
  3998. case OBJECT_TYPE_TEXTURE: {
  3999. const TextureInfo *tex_info = (const TextureInfo *)p_driver_id.id;
  4000. if (tex_info->allocation.handle) {
  4001. _set_object_name(VK_OBJECT_TYPE_IMAGE, (uint64_t)tex_info->vk_view_create_info.image, p_name);
  4002. }
  4003. _set_object_name(VK_OBJECT_TYPE_IMAGE_VIEW, (uint64_t)tex_info->vk_view, p_name + " View");
  4004. } break;
  4005. case OBJECT_TYPE_SAMPLER: {
  4006. _set_object_name(VK_OBJECT_TYPE_SAMPLER, p_driver_id.id, p_name);
  4007. } break;
  4008. case OBJECT_TYPE_BUFFER: {
  4009. const BufferInfo *buf_info = (const BufferInfo *)p_driver_id.id;
  4010. _set_object_name(VK_OBJECT_TYPE_BUFFER, (uint64_t)buf_info->vk_buffer, p_name);
  4011. if (buf_info->vk_view) {
  4012. _set_object_name(VK_OBJECT_TYPE_BUFFER_VIEW, (uint64_t)buf_info->vk_view, p_name + " View");
  4013. }
  4014. } break;
  4015. case OBJECT_TYPE_SHADER: {
  4016. const ShaderInfo *shader_info = (const ShaderInfo *)p_driver_id.id;
  4017. for (uint32_t i = 0; i < shader_info->vk_descriptor_set_layouts.size(); i++) {
  4018. _set_object_name(VK_OBJECT_TYPE_DESCRIPTOR_SET_LAYOUT, (uint64_t)shader_info->vk_descriptor_set_layouts[i], p_name);
  4019. }
  4020. _set_object_name(VK_OBJECT_TYPE_PIPELINE_LAYOUT, (uint64_t)shader_info->vk_pipeline_layout, p_name + " Pipeline Layout");
  4021. } break;
  4022. case OBJECT_TYPE_UNIFORM_SET: {
  4023. const UniformSetInfo *usi = (const UniformSetInfo *)p_driver_id.id;
  4024. _set_object_name(VK_OBJECT_TYPE_DESCRIPTOR_SET, (uint64_t)usi->vk_descriptor_set, p_name);
  4025. } break;
  4026. case OBJECT_TYPE_PIPELINE: {
  4027. _set_object_name(VK_OBJECT_TYPE_PIPELINE, (uint64_t)p_driver_id.id, p_name);
  4028. } break;
  4029. default: {
  4030. DEV_ASSERT(false);
  4031. }
  4032. }
  4033. }
  4034. uint64_t RenderingDeviceDriverVulkan::get_resource_native_handle(DriverResource p_type, ID p_driver_id) {
  4035. switch (p_type) {
  4036. case DRIVER_RESOURCE_LOGICAL_DEVICE: {
  4037. return (uint64_t)vk_device;
  4038. }
  4039. case DRIVER_RESOURCE_PHYSICAL_DEVICE: {
  4040. return (uint64_t)physical_device;
  4041. }
  4042. case DRIVER_RESOURCE_TOPMOST_OBJECT: {
  4043. return (uint64_t)context_driver->instance_get();
  4044. }
  4045. case DRIVER_RESOURCE_COMMAND_QUEUE: {
  4046. const CommandQueue *queue_info = (const CommandQueue *)p_driver_id.id;
  4047. return (uint64_t)queue_families[queue_info->queue_family][queue_info->queue_index].queue;
  4048. }
  4049. case DRIVER_RESOURCE_QUEUE_FAMILY: {
  4050. return uint32_t(p_driver_id.id) - 1;
  4051. }
  4052. case DRIVER_RESOURCE_TEXTURE: {
  4053. const TextureInfo *tex_info = (const TextureInfo *)p_driver_id.id;
  4054. return (uint64_t)tex_info->vk_view_create_info.image;
  4055. }
  4056. case DRIVER_RESOURCE_TEXTURE_VIEW: {
  4057. const TextureInfo *tex_info = (const TextureInfo *)p_driver_id.id;
  4058. return (uint64_t)tex_info->vk_view;
  4059. }
  4060. case DRIVER_RESOURCE_TEXTURE_DATA_FORMAT: {
  4061. const TextureInfo *tex_info = (const TextureInfo *)p_driver_id.id;
  4062. return (uint64_t)tex_info->vk_view_create_info.format;
  4063. }
  4064. case DRIVER_RESOURCE_SAMPLER:
  4065. case DRIVER_RESOURCE_UNIFORM_SET:
  4066. case DRIVER_RESOURCE_BUFFER:
  4067. case DRIVER_RESOURCE_COMPUTE_PIPELINE:
  4068. case DRIVER_RESOURCE_RENDER_PIPELINE: {
  4069. return p_driver_id.id;
  4070. }
  4071. default: {
  4072. return 0;
  4073. }
  4074. }
  4075. }
  4076. uint64_t RenderingDeviceDriverVulkan::get_total_memory_used() {
  4077. VmaTotalStatistics stats = {};
  4078. vmaCalculateStatistics(allocator, &stats);
  4079. return stats.total.statistics.allocationBytes;
  4080. }
  4081. uint64_t RenderingDeviceDriverVulkan::limit_get(Limit p_limit) {
  4082. const VkPhysicalDeviceLimits &limits = physical_device_properties.limits;
  4083. switch (p_limit) {
  4084. case LIMIT_MAX_BOUND_UNIFORM_SETS:
  4085. return limits.maxBoundDescriptorSets;
  4086. case LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS:
  4087. return limits.maxColorAttachments;
  4088. case LIMIT_MAX_TEXTURES_PER_UNIFORM_SET:
  4089. return limits.maxDescriptorSetSampledImages;
  4090. case LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET:
  4091. return limits.maxDescriptorSetSamplers;
  4092. case LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET:
  4093. return limits.maxDescriptorSetStorageBuffers;
  4094. case LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET:
  4095. return limits.maxDescriptorSetStorageImages;
  4096. case LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET:
  4097. return limits.maxDescriptorSetUniformBuffers;
  4098. case LIMIT_MAX_DRAW_INDEXED_INDEX:
  4099. return limits.maxDrawIndexedIndexValue;
  4100. case LIMIT_MAX_FRAMEBUFFER_HEIGHT:
  4101. return limits.maxFramebufferHeight;
  4102. case LIMIT_MAX_FRAMEBUFFER_WIDTH:
  4103. return limits.maxFramebufferWidth;
  4104. case LIMIT_MAX_TEXTURE_ARRAY_LAYERS:
  4105. return limits.maxImageArrayLayers;
  4106. case LIMIT_MAX_TEXTURE_SIZE_1D:
  4107. return limits.maxImageDimension1D;
  4108. case LIMIT_MAX_TEXTURE_SIZE_2D:
  4109. return limits.maxImageDimension2D;
  4110. case LIMIT_MAX_TEXTURE_SIZE_3D:
  4111. return limits.maxImageDimension3D;
  4112. case LIMIT_MAX_TEXTURE_SIZE_CUBE:
  4113. return limits.maxImageDimensionCube;
  4114. case LIMIT_MAX_TEXTURES_PER_SHADER_STAGE:
  4115. return limits.maxPerStageDescriptorSampledImages;
  4116. case LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE:
  4117. return limits.maxPerStageDescriptorSamplers;
  4118. case LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE:
  4119. return limits.maxPerStageDescriptorStorageBuffers;
  4120. case LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE:
  4121. return limits.maxPerStageDescriptorStorageImages;
  4122. case LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE:
  4123. return limits.maxPerStageDescriptorUniformBuffers;
  4124. case LIMIT_MAX_PUSH_CONSTANT_SIZE:
  4125. return limits.maxPushConstantsSize;
  4126. case LIMIT_MAX_UNIFORM_BUFFER_SIZE:
  4127. return limits.maxUniformBufferRange;
  4128. case LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET:
  4129. return limits.maxVertexInputAttributeOffset;
  4130. case LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES:
  4131. return limits.maxVertexInputAttributes;
  4132. case LIMIT_MAX_VERTEX_INPUT_BINDINGS:
  4133. return limits.maxVertexInputBindings;
  4134. case LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE:
  4135. return limits.maxVertexInputBindingStride;
  4136. case LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT:
  4137. return limits.minUniformBufferOffsetAlignment;
  4138. case LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X:
  4139. return limits.maxComputeWorkGroupCount[0];
  4140. case LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y:
  4141. return limits.maxComputeWorkGroupCount[1];
  4142. case LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z:
  4143. return limits.maxComputeWorkGroupCount[2];
  4144. case LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS:
  4145. return limits.maxComputeWorkGroupInvocations;
  4146. case LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X:
  4147. return limits.maxComputeWorkGroupSize[0];
  4148. case LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y:
  4149. return limits.maxComputeWorkGroupSize[1];
  4150. case LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z:
  4151. return limits.maxComputeWorkGroupSize[2];
  4152. case LIMIT_MAX_VIEWPORT_DIMENSIONS_X:
  4153. return limits.maxViewportDimensions[0];
  4154. case LIMIT_MAX_VIEWPORT_DIMENSIONS_Y:
  4155. return limits.maxViewportDimensions[1];
  4156. case LIMIT_SUBGROUP_SIZE:
  4157. return subgroup_capabilities.size;
  4158. case LIMIT_SUBGROUP_MIN_SIZE:
  4159. return subgroup_capabilities.min_size;
  4160. case LIMIT_SUBGROUP_MAX_SIZE:
  4161. return subgroup_capabilities.max_size;
  4162. case LIMIT_SUBGROUP_IN_SHADERS:
  4163. return subgroup_capabilities.supported_stages_flags_rd();
  4164. case LIMIT_SUBGROUP_OPERATIONS:
  4165. return subgroup_capabilities.supported_operations_flags_rd();
  4166. case LIMIT_VRS_TEXEL_WIDTH:
  4167. return vrs_capabilities.texel_size.x;
  4168. case LIMIT_VRS_TEXEL_HEIGHT:
  4169. return vrs_capabilities.texel_size.y;
  4170. default:
  4171. ERR_FAIL_V(0);
  4172. }
  4173. }
  4174. uint64_t RenderingDeviceDriverVulkan::api_trait_get(ApiTrait p_trait) {
  4175. switch (p_trait) {
  4176. case API_TRAIT_TEXTURE_TRANSFER_ALIGNMENT:
  4177. return (uint64_t)MAX((uint64_t)16, physical_device_properties.limits.optimalBufferCopyOffsetAlignment);
  4178. case API_TRAIT_SHADER_CHANGE_INVALIDATION:
  4179. return (uint64_t)SHADER_CHANGE_INVALIDATION_INCOMPATIBLE_SETS_PLUS_CASCADE;
  4180. default:
  4181. return RenderingDeviceDriver::api_trait_get(p_trait);
  4182. }
  4183. }
  4184. bool RenderingDeviceDriverVulkan::has_feature(Features p_feature) {
  4185. switch (p_feature) {
  4186. case SUPPORTS_MULTIVIEW:
  4187. return multiview_capabilities.is_supported && multiview_capabilities.max_view_count > 1;
  4188. case SUPPORTS_FSR_HALF_FLOAT:
  4189. return shader_capabilities.shader_float16_is_supported && physical_device_features.shaderInt16 && storage_buffer_capabilities.storage_buffer_16_bit_access_is_supported;
  4190. case SUPPORTS_ATTACHMENT_VRS:
  4191. return vrs_capabilities.attachment_vrs_supported && physical_device_features.shaderStorageImageExtendedFormats;
  4192. case SUPPORTS_FRAGMENT_SHADER_WITH_ONLY_SIDE_EFFECTS:
  4193. return true;
  4194. default:
  4195. return false;
  4196. }
  4197. }
  4198. const RDD::MultiviewCapabilities &RenderingDeviceDriverVulkan::get_multiview_capabilities() {
  4199. return multiview_capabilities;
  4200. }
  4201. String RenderingDeviceDriverVulkan::get_api_name() const {
  4202. return "Vulkan";
  4203. }
  4204. String RenderingDeviceDriverVulkan::get_api_version() const {
  4205. uint32_t api_version = physical_device_properties.apiVersion;
  4206. return vformat("%d.%d.%d", VK_API_VERSION_MAJOR(api_version), VK_API_VERSION_MINOR(api_version), VK_API_VERSION_PATCH(api_version));
  4207. }
  4208. String RenderingDeviceDriverVulkan::get_pipeline_cache_uuid() const {
  4209. return pipeline_cache_id;
  4210. }
  4211. const RDD::Capabilities &RenderingDeviceDriverVulkan::get_capabilities() const {
  4212. return device_capabilities;
  4213. }
  4214. /******************/
  4215. RenderingDeviceDriverVulkan::RenderingDeviceDriverVulkan(RenderingContextDriverVulkan *p_context_driver) {
  4216. DEV_ASSERT(p_context_driver != nullptr);
  4217. context_driver = p_context_driver;
  4218. }
  4219. RenderingDeviceDriverVulkan::~RenderingDeviceDriverVulkan() {
  4220. while (small_allocs_pools.size()) {
  4221. HashMap<uint32_t, VmaPool>::Iterator E = small_allocs_pools.begin();
  4222. vmaDestroyPool(allocator, E->value);
  4223. small_allocs_pools.remove(E);
  4224. }
  4225. vmaDestroyAllocator(allocator);
  4226. if (vk_device != VK_NULL_HANDLE) {
  4227. vkDestroyDevice(vk_device, nullptr);
  4228. }
  4229. }