rendering_device_driver_vulkan.cpp 228 KB

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