class_renderingdevice.rst 232 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/RenderingDevice.xml.
  6. .. _class_RenderingDevice:
  7. RenderingDevice
  8. ===============
  9. **Inherits:** :ref:`Object<class_Object>`
  10. Methods
  11. -------
  12. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  13. | void | :ref:`barrier<class_RenderingDevice_method_barrier>` **(** :ref:`int<class_int>` from=7, :ref:`int<class_int>` to=7 **)** |
  14. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`buffer_clear<class_RenderingDevice_method_buffer_clear>` **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset, :ref:`int<class_int>` size_bytes, :ref:`int<class_int>` post_barrier=7 **)** |
  16. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`buffer_get_data<class_RenderingDevice_method_buffer_get_data>` **(** :ref:`RID<class_RID>` buffer **)** |
  18. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`buffer_update<class_RenderingDevice_method_buffer_update>` **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset, :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data, :ref:`int<class_int>` post_barrier=7 **)** |
  20. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`capture_timestamp<class_RenderingDevice_method_capture_timestamp>` **(** :ref:`String<class_String>` name **)** |
  22. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`compute_list_add_barrier<class_RenderingDevice_method_compute_list_add_barrier>` **(** :ref:`int<class_int>` compute_list **)** |
  24. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | :ref:`int<class_int>` | :ref:`compute_list_begin<class_RenderingDevice_method_compute_list_begin>` **(** :ref:`bool<class_bool>` allow_draw_overlap=false **)** |
  26. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`compute_list_bind_compute_pipeline<class_RenderingDevice_method_compute_list_bind_compute_pipeline>` **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` compute_pipeline **)** |
  28. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`compute_list_bind_uniform_set<class_RenderingDevice_method_compute_list_bind_uniform_set>` **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)** |
  30. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`compute_list_dispatch<class_RenderingDevice_method_compute_list_dispatch>` **(** :ref:`int<class_int>` compute_list, :ref:`int<class_int>` x_groups, :ref:`int<class_int>` y_groups, :ref:`int<class_int>` z_groups **)** |
  32. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | void | :ref:`compute_list_end<class_RenderingDevice_method_compute_list_end>` **(** :ref:`int<class_int>` post_barrier=7 **)** |
  34. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | void | :ref:`compute_list_set_push_constant<class_RenderingDevice_method_compute_list_set_push_constant>` **(** :ref:`int<class_int>` compute_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)** |
  36. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | :ref:`RID<class_RID>` | :ref:`compute_pipeline_create<class_RenderingDevice_method_compute_pipeline_create>` **(** :ref:`RID<class_RID>` shader, :ref:`RDPipelineSpecializationConstant[]<class_RDPipelineSpecializationConstant>` specialization_constants=[] **)** |
  38. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | :ref:`bool<class_bool>` | :ref:`compute_pipeline_is_valid<class_RenderingDevice_method_compute_pipeline_is_valid>` **(** :ref:`RID<class_RID>` compute_pieline **)** |
  40. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | :ref:`RenderingDevice<class_RenderingDevice>` | :ref:`create_local_device<class_RenderingDevice_method_create_local_device>` **(** **)** |
  42. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`draw_command_begin_label<class_RenderingDevice_method_draw_command_begin_label>` **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)** |
  44. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`draw_command_end_label<class_RenderingDevice_method_draw_command_end_label>` **(** **)** |
  46. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`draw_command_insert_label<class_RenderingDevice_method_draw_command_insert_label>` **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)** |
  48. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`int<class_int>` | :ref:`draw_list_begin<class_RenderingDevice_method_draw_list_begin>` **(** :ref:`RID<class_RID>` framebuffer, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_color_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_color_action, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_depth_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_depth_action, :ref:`PackedColorArray<class_PackedColorArray>` clear_color_values=PackedColorArray(), :ref:`float<class_float>` clear_depth=1.0, :ref:`int<class_int>` clear_stencil=0, :ref:`Rect2<class_Rect2>` region=Rect2(0, 0, 0, 0), :ref:`Array<class_Array>` storage_textures=[] **)** |
  50. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`int<class_int>` | :ref:`draw_list_begin_for_screen<class_RenderingDevice_method_draw_list_begin_for_screen>` **(** :ref:`int<class_int>` screen=0, :ref:`Color<class_Color>` clear_color=Color(0, 0, 0, 1) **)** |
  52. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`draw_list_begin_split<class_RenderingDevice_method_draw_list_begin_split>` **(** :ref:`RID<class_RID>` framebuffer, :ref:`int<class_int>` splits, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_color_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_color_action, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_depth_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_depth_action, :ref:`PackedColorArray<class_PackedColorArray>` clear_color_values=PackedColorArray(), :ref:`float<class_float>` clear_depth=1.0, :ref:`int<class_int>` clear_stencil=0, :ref:`Rect2<class_Rect2>` region=Rect2(0, 0, 0, 0), :ref:`RID[]<class_RID>` storage_textures=[] **)** |
  54. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`draw_list_bind_index_array<class_RenderingDevice_method_draw_list_bind_index_array>` **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` index_array **)** |
  56. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | void | :ref:`draw_list_bind_render_pipeline<class_RenderingDevice_method_draw_list_bind_render_pipeline>` **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` render_pipeline **)** |
  58. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | void | :ref:`draw_list_bind_uniform_set<class_RenderingDevice_method_draw_list_bind_uniform_set>` **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)** |
  60. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`draw_list_bind_vertex_array<class_RenderingDevice_method_draw_list_bind_vertex_array>` **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` vertex_array **)** |
  62. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`draw_list_disable_scissor<class_RenderingDevice_method_draw_list_disable_scissor>` **(** :ref:`int<class_int>` draw_list **)** |
  64. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`draw_list_draw<class_RenderingDevice_method_draw_list_draw>` **(** :ref:`int<class_int>` draw_list, :ref:`bool<class_bool>` use_indices, :ref:`int<class_int>` instances, :ref:`int<class_int>` procedural_vertex_count=0 **)** |
  66. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | void | :ref:`draw_list_enable_scissor<class_RenderingDevice_method_draw_list_enable_scissor>` **(** :ref:`int<class_int>` draw_list, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)** |
  68. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`draw_list_end<class_RenderingDevice_method_draw_list_end>` **(** :ref:`int<class_int>` post_barrier=7 **)** |
  70. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`draw_list_set_blend_constants<class_RenderingDevice_method_draw_list_set_blend_constants>` **(** :ref:`int<class_int>` draw_list, :ref:`Color<class_Color>` color **)** |
  72. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`draw_list_set_push_constant<class_RenderingDevice_method_draw_list_set_push_constant>` **(** :ref:`int<class_int>` draw_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)** |
  74. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`int<class_int>` | :ref:`draw_list_switch_to_next_pass<class_RenderingDevice_method_draw_list_switch_to_next_pass>` **(** **)** |
  76. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`PackedInt64Array<class_PackedInt64Array>` | :ref:`draw_list_switch_to_next_pass_split<class_RenderingDevice_method_draw_list_switch_to_next_pass_split>` **(** :ref:`int<class_int>` splits **)** |
  78. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`RID<class_RID>` | :ref:`framebuffer_create<class_RenderingDevice_method_framebuffer_create>` **(** :ref:`RID[]<class_RID>` textures, :ref:`int<class_int>` validate_with_format=-1, :ref:`int<class_int>` view_count=1 **)** |
  80. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`RID<class_RID>` | :ref:`framebuffer_create_empty<class_RenderingDevice_method_framebuffer_create_empty>` **(** :ref:`Vector2i<class_Vector2i>` size, :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples=0, :ref:`int<class_int>` validate_with_format=-1 **)** |
  82. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`RID<class_RID>` | :ref:`framebuffer_create_multipass<class_RenderingDevice_method_framebuffer_create_multipass>` **(** :ref:`RID[]<class_RID>` textures, :ref:`RDFramebufferPass[]<class_RDFramebufferPass>` passes, :ref:`int<class_int>` validate_with_format=-1, :ref:`int<class_int>` view_count=1 **)** |
  84. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`int<class_int>` | :ref:`framebuffer_format_create<class_RenderingDevice_method_framebuffer_format_create>` **(** :ref:`RDAttachmentFormat[]<class_RDAttachmentFormat>` attachments, :ref:`int<class_int>` view_count=1 **)** |
  86. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`int<class_int>` | :ref:`framebuffer_format_create_empty<class_RenderingDevice_method_framebuffer_format_create_empty>` **(** :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples=0 **)** |
  88. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`int<class_int>` | :ref:`framebuffer_format_create_multipass<class_RenderingDevice_method_framebuffer_format_create_multipass>` **(** :ref:`RDAttachmentFormat[]<class_RDAttachmentFormat>` attachments, :ref:`RDFramebufferPass[]<class_RDFramebufferPass>` passes, :ref:`int<class_int>` view_count=1 **)** |
  90. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` | :ref:`framebuffer_format_get_texture_samples<class_RenderingDevice_method_framebuffer_format_get_texture_samples>` **(** :ref:`int<class_int>` format, :ref:`int<class_int>` render_pass=0 **)** |
  92. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`int<class_int>` | :ref:`framebuffer_get_format<class_RenderingDevice_method_framebuffer_get_format>` **(** :ref:`RID<class_RID>` framebuffer **)** |
  94. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`bool<class_bool>` | :ref:`framebuffer_is_valid<class_RenderingDevice_method_framebuffer_is_valid>` **(** :ref:`RID<class_RID>` framebuffer **)** |const| |
  96. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | void | :ref:`free_rid<class_RenderingDevice_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  98. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | void | :ref:`full_barrier<class_RenderingDevice_method_full_barrier>` **(** **)** |
  100. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`int<class_int>` | :ref:`get_captured_timestamp_cpu_time<class_RenderingDevice_method_get_captured_timestamp_cpu_time>` **(** :ref:`int<class_int>` index **)** |const| |
  102. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`int<class_int>` | :ref:`get_captured_timestamp_gpu_time<class_RenderingDevice_method_get_captured_timestamp_gpu_time>` **(** :ref:`int<class_int>` index **)** |const| |
  104. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`String<class_String>` | :ref:`get_captured_timestamp_name<class_RenderingDevice_method_get_captured_timestamp_name>` **(** :ref:`int<class_int>` index **)** |const| |
  106. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`int<class_int>` | :ref:`get_captured_timestamps_count<class_RenderingDevice_method_get_captured_timestamps_count>` **(** **)** |const| |
  108. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`int<class_int>` | :ref:`get_captured_timestamps_frame<class_RenderingDevice_method_get_captured_timestamps_frame>` **(** **)** |const| |
  110. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`String<class_String>` | :ref:`get_device_name<class_RenderingDevice_method_get_device_name>` **(** **)** |const| |
  112. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`String<class_String>` | :ref:`get_device_pipeline_cache_uuid<class_RenderingDevice_method_get_device_pipeline_cache_uuid>` **(** **)** |const| |
  114. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`String<class_String>` | :ref:`get_device_vendor_name<class_RenderingDevice_method_get_device_vendor_name>` **(** **)** |const| |
  116. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`int<class_int>` | :ref:`get_driver_resource<class_RenderingDevice_method_get_driver_resource>` **(** :ref:`DriverResource<enum_RenderingDevice_DriverResource>` resource, :ref:`RID<class_RID>` rid, :ref:`int<class_int>` index **)** |
  118. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`int<class_int>` | :ref:`get_frame_delay<class_RenderingDevice_method_get_frame_delay>` **(** **)** |const| |
  120. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`int<class_int>` | :ref:`get_memory_usage<class_RenderingDevice_method_get_memory_usage>` **(** :ref:`MemoryType<enum_RenderingDevice_MemoryType>` type **)** |const| |
  122. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`RID<class_RID>` | :ref:`index_array_create<class_RenderingDevice_method_index_array_create>` **(** :ref:`RID<class_RID>` index_buffer, :ref:`int<class_int>` index_offset, :ref:`int<class_int>` index_count **)** |
  124. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`RID<class_RID>` | :ref:`index_buffer_create<class_RenderingDevice_method_index_buffer_create>` **(** :ref:`int<class_int>` size_indices, :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` format, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`bool<class_bool>` use_restart_indices=false **)** |
  126. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`int<class_int>` | :ref:`limit_get<class_RenderingDevice_method_limit_get>` **(** :ref:`Limit<enum_RenderingDevice_Limit>` limit **)** |const| |
  128. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`RID<class_RID>` | :ref:`render_pipeline_create<class_RenderingDevice_method_render_pipeline_create>` **(** :ref:`RID<class_RID>` shader, :ref:`int<class_int>` framebuffer_format, :ref:`int<class_int>` vertex_format, :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` primitive, :ref:`RDPipelineRasterizationState<class_RDPipelineRasterizationState>` rasterization_state, :ref:`RDPipelineMultisampleState<class_RDPipelineMultisampleState>` multisample_state, :ref:`RDPipelineDepthStencilState<class_RDPipelineDepthStencilState>` stencil_state, :ref:`RDPipelineColorBlendState<class_RDPipelineColorBlendState>` color_blend_state, :ref:`int<class_int>` dynamic_state_flags=0, :ref:`int<class_int>` for_render_pass=0, :ref:`RDPipelineSpecializationConstant[]<class_RDPipelineSpecializationConstant>` specialization_constants=[] **)** |
  130. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`bool<class_bool>` | :ref:`render_pipeline_is_valid<class_RenderingDevice_method_render_pipeline_is_valid>` **(** :ref:`RID<class_RID>` render_pipeline **)** |
  132. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`RID<class_RID>` | :ref:`sampler_create<class_RenderingDevice_method_sampler_create>` **(** :ref:`RDSamplerState<class_RDSamplerState>` state **)** |
  134. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`int<class_int>` | :ref:`screen_get_framebuffer_format<class_RenderingDevice_method_screen_get_framebuffer_format>` **(** **)** |const| |
  136. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`int<class_int>` | :ref:`screen_get_height<class_RenderingDevice_method_screen_get_height>` **(** :ref:`int<class_int>` screen=0 **)** |const| |
  138. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`int<class_int>` | :ref:`screen_get_width<class_RenderingDevice_method_screen_get_width>` **(** :ref:`int<class_int>` screen=0 **)** |const| |
  140. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | void | :ref:`set_resource_name<class_RenderingDevice_method_set_resource_name>` **(** :ref:`RID<class_RID>` id, :ref:`String<class_String>` name **)** |
  142. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`shader_compile_binary_from_spirv<class_RenderingDevice_method_shader_compile_binary_from_spirv>` **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)** |
  144. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` | :ref:`shader_compile_spirv_from_source<class_RenderingDevice_method_shader_compile_spirv_from_source>` **(** :ref:`RDShaderSource<class_RDShaderSource>` shader_source, :ref:`bool<class_bool>` allow_cache=true **)** |
  146. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | :ref:`RID<class_RID>` | :ref:`shader_create_from_bytecode<class_RenderingDevice_method_shader_create_from_bytecode>` **(** :ref:`PackedByteArray<class_PackedByteArray>` binary_data **)** |
  148. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | :ref:`RID<class_RID>` | :ref:`shader_create_from_spirv<class_RenderingDevice_method_shader_create_from_spirv>` **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)** |
  150. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | :ref:`int<class_int>` | :ref:`shader_get_vertex_input_attribute_mask<class_RenderingDevice_method_shader_get_vertex_input_attribute_mask>` **(** :ref:`RID<class_RID>` shader **)** |
  152. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | :ref:`RID<class_RID>` | :ref:`storage_buffer_create<class_RenderingDevice_method_storage_buffer_create>` **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`int<class_int>` usage=0 **)** |
  154. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | void | :ref:`submit<class_RenderingDevice_method_submit>` **(** **)** |
  156. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | void | :ref:`sync<class_RenderingDevice_method_sync>` **(** **)** |
  158. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | :ref:`RID<class_RID>` | :ref:`texture_buffer_create<class_RenderingDevice_method_texture_buffer_create>` **(** :ref:`int<class_int>` size_bytes, :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray() **)** |
  160. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_clear<class_RenderingDevice_method_texture_clear>` **(** :ref:`RID<class_RID>` texture, :ref:`Color<class_Color>` color, :ref:`int<class_int>` base_mipmap, :ref:`int<class_int>` mipmap_count, :ref:`int<class_int>` base_layer, :ref:`int<class_int>` layer_count, :ref:`int<class_int>` post_barrier=7 **)** |
  162. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_copy<class_RenderingDevice_method_texture_copy>` **(** :ref:`RID<class_RID>` from_texture, :ref:`RID<class_RID>` to_texture, :ref:`Vector3<class_Vector3>` from_pos, :ref:`Vector3<class_Vector3>` to_pos, :ref:`Vector3<class_Vector3>` size, :ref:`int<class_int>` src_mipmap, :ref:`int<class_int>` dst_mipmap, :ref:`int<class_int>` src_layer, :ref:`int<class_int>` dst_layer, :ref:`int<class_int>` post_barrier=7 **)** |
  164. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :ref:`RID<class_RID>` | :ref:`texture_create<class_RenderingDevice_method_texture_create>` **(** :ref:`RDTextureFormat<class_RDTextureFormat>` format, :ref:`RDTextureView<class_RDTextureView>` view, :ref:`PackedByteArray[]<class_PackedByteArray>` data=[] **)** |
  166. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :ref:`RID<class_RID>` | :ref:`texture_create_shared<class_RenderingDevice_method_texture_create_shared>` **(** :ref:`RDTextureView<class_RDTextureView>` view, :ref:`RID<class_RID>` with_texture **)** |
  168. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | :ref:`RID<class_RID>` | :ref:`texture_create_shared_from_slice<class_RenderingDevice_method_texture_create_shared_from_slice>` **(** :ref:`RDTextureView<class_RDTextureView>` view, :ref:`RID<class_RID>` with_texture, :ref:`int<class_int>` layer, :ref:`int<class_int>` mipmap, :ref:`int<class_int>` mipmaps=1, :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` slice_type=0 **)** |
  170. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`texture_get_data<class_RenderingDevice_method_texture_get_data>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)** |
  172. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | :ref:`bool<class_bool>` | :ref:`texture_is_format_supported_for_usage<class_RenderingDevice_method_texture_is_format_supported_for_usage>` **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`int<class_int>` usage_flags **)** |const| |
  174. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | :ref:`bool<class_bool>` | :ref:`texture_is_shared<class_RenderingDevice_method_texture_is_shared>` **(** :ref:`RID<class_RID>` texture **)** |
  176. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | :ref:`bool<class_bool>` | :ref:`texture_is_valid<class_RenderingDevice_method_texture_is_valid>` **(** :ref:`RID<class_RID>` texture **)** |
  178. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_resolve_multisample<class_RenderingDevice_method_texture_resolve_multisample>` **(** :ref:`RID<class_RID>` from_texture, :ref:`RID<class_RID>` to_texture, :ref:`int<class_int>` post_barrier=7 **)** |
  180. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`texture_update<class_RenderingDevice_method_texture_update>` **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer, :ref:`PackedByteArray<class_PackedByteArray>` data, :ref:`int<class_int>` post_barrier=7 **)** |
  182. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | :ref:`RID<class_RID>` | :ref:`uniform_buffer_create<class_RenderingDevice_method_uniform_buffer_create>` **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray() **)** |
  184. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | :ref:`RID<class_RID>` | :ref:`uniform_set_create<class_RenderingDevice_method_uniform_set_create>` **(** :ref:`RDUniform[]<class_RDUniform>` uniforms, :ref:`RID<class_RID>` shader, :ref:`int<class_int>` shader_set **)** |
  186. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :ref:`bool<class_bool>` | :ref:`uniform_set_is_valid<class_RenderingDevice_method_uniform_set_is_valid>` **(** :ref:`RID<class_RID>` uniform_set **)** |
  188. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | :ref:`RID<class_RID>` | :ref:`vertex_buffer_create<class_RenderingDevice_method_vertex_buffer_create>` **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`bool<class_bool>` use_as_storage=false **)** |
  190. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | :ref:`int<class_int>` | :ref:`vertex_format_create<class_RenderingDevice_method_vertex_format_create>` **(** :ref:`RDVertexAttribute[]<class_RDVertexAttribute>` vertex_descriptions **)** |
  192. +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. Enumerations
  194. ------------
  195. .. _enum_RenderingDevice_DeviceType:
  196. .. _class_RenderingDevice_constant_DEVICE_TYPE_OTHER:
  197. .. _class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU:
  198. .. _class_RenderingDevice_constant_DEVICE_TYPE_DISCRETE_GPU:
  199. .. _class_RenderingDevice_constant_DEVICE_TYPE_VIRTUAL_GPU:
  200. .. _class_RenderingDevice_constant_DEVICE_TYPE_CPU:
  201. .. _class_RenderingDevice_constant_DEVICE_TYPE_MAX:
  202. enum **DeviceType**:
  203. - **DEVICE_TYPE_OTHER** = **0** --- Rendering device type does not match any of the other enum values or is unknown.
  204. - **DEVICE_TYPE_INTEGRATED_GPU** = **1** --- Rendering device is an integrated GPU, which is typically *(but not always)* slower than dedicated GPUs (:ref:`DEVICE_TYPE_DISCRETE_GPU<class_RenderingDevice_constant_DEVICE_TYPE_DISCRETE_GPU>`). On Android and iOS, the rendering device type is always considered to be :ref:`DEVICE_TYPE_INTEGRATED_GPU<class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU>`.
  205. - **DEVICE_TYPE_DISCRETE_GPU** = **2** --- Rendering device is a dedicated GPU, which is typically *(but not always)* faster than integrated GPUs (:ref:`DEVICE_TYPE_INTEGRATED_GPU<class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU>`).
  206. - **DEVICE_TYPE_VIRTUAL_GPU** = **3** --- Rendering device is an emulated GPU in a virtual environment. This is typically much slower than the host GPU, which means the expected performance level on a dedicated GPU will be roughly equivalent to :ref:`DEVICE_TYPE_INTEGRATED_GPU<class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU>`. Virtual machine GPU passthrough (such as VFIO) will not report the device type as :ref:`DEVICE_TYPE_VIRTUAL_GPU<class_RenderingDevice_constant_DEVICE_TYPE_VIRTUAL_GPU>`. Instead, the host GPU's device type will be reported as if the GPU was not emulated.
  207. - **DEVICE_TYPE_CPU** = **4** --- Rendering device is provided by software emulation (such as Lavapipe or `SwiftShader <https://github.com/google/swiftshader>`__). This is the slowest kind of rendering device available; it's typically much slower than :ref:`DEVICE_TYPE_INTEGRATED_GPU<class_RenderingDevice_constant_DEVICE_TYPE_INTEGRATED_GPU>`.
  208. - **DEVICE_TYPE_MAX** = **5** --- Represents the size of the :ref:`DeviceType<enum_RenderingDevice_DeviceType>` enum.
  209. ----
  210. .. _enum_RenderingDevice_DriverResource:
  211. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DEVICE:
  212. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE:
  213. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_INSTANCE:
  214. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE:
  215. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX:
  216. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE:
  217. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_VIEW:
  218. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT:
  219. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_SAMPLER:
  220. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET:
  221. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_BUFFER:
  222. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE:
  223. .. _class_RenderingDevice_constant_DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE:
  224. enum **DriverResource**:
  225. - **DRIVER_RESOURCE_VULKAN_DEVICE** = **0**
  226. - **DRIVER_RESOURCE_VULKAN_PHYSICAL_DEVICE** = **1**
  227. - **DRIVER_RESOURCE_VULKAN_INSTANCE** = **2**
  228. - **DRIVER_RESOURCE_VULKAN_QUEUE** = **3**
  229. - **DRIVER_RESOURCE_VULKAN_QUEUE_FAMILY_INDEX** = **4**
  230. - **DRIVER_RESOURCE_VULKAN_IMAGE** = **5**
  231. - **DRIVER_RESOURCE_VULKAN_IMAGE_VIEW** = **6**
  232. - **DRIVER_RESOURCE_VULKAN_IMAGE_NATIVE_TEXTURE_FORMAT** = **7**
  233. - **DRIVER_RESOURCE_VULKAN_SAMPLER** = **8**
  234. - **DRIVER_RESOURCE_VULKAN_DESCRIPTOR_SET** = **9**
  235. - **DRIVER_RESOURCE_VULKAN_BUFFER** = **10**
  236. - **DRIVER_RESOURCE_VULKAN_COMPUTE_PIPELINE** = **11**
  237. - **DRIVER_RESOURCE_VULKAN_RENDER_PIPELINE** = **12**
  238. ----
  239. .. _enum_RenderingDevice_DataFormat:
  240. .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4_UNORM_PACK8:
  241. .. _class_RenderingDevice_constant_DATA_FORMAT_R4G4B4A4_UNORM_PACK16:
  242. .. _class_RenderingDevice_constant_DATA_FORMAT_B4G4R4A4_UNORM_PACK16:
  243. .. _class_RenderingDevice_constant_DATA_FORMAT_R5G6B5_UNORM_PACK16:
  244. .. _class_RenderingDevice_constant_DATA_FORMAT_B5G6R5_UNORM_PACK16:
  245. .. _class_RenderingDevice_constant_DATA_FORMAT_R5G5B5A1_UNORM_PACK16:
  246. .. _class_RenderingDevice_constant_DATA_FORMAT_B5G5R5A1_UNORM_PACK16:
  247. .. _class_RenderingDevice_constant_DATA_FORMAT_A1R5G5B5_UNORM_PACK16:
  248. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UNORM:
  249. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SNORM:
  250. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_USCALED:
  251. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SSCALED:
  252. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_UINT:
  253. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SINT:
  254. .. _class_RenderingDevice_constant_DATA_FORMAT_R8_SRGB:
  255. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UNORM:
  256. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SNORM:
  257. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_USCALED:
  258. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SSCALED:
  259. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_UINT:
  260. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SINT:
  261. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8_SRGB:
  262. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UNORM:
  263. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SNORM:
  264. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_USCALED:
  265. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SSCALED:
  266. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_UINT:
  267. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SINT:
  268. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8_SRGB:
  269. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UNORM:
  270. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SNORM:
  271. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_USCALED:
  272. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SSCALED:
  273. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_UINT:
  274. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SINT:
  275. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8_SRGB:
  276. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UNORM:
  277. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SNORM:
  278. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_USCALED:
  279. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SSCALED:
  280. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_UINT:
  281. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SINT:
  282. .. _class_RenderingDevice_constant_DATA_FORMAT_R8G8B8A8_SRGB:
  283. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UNORM:
  284. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SNORM:
  285. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_USCALED:
  286. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SSCALED:
  287. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_UINT:
  288. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SINT:
  289. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8A8_SRGB:
  290. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UNORM_PACK32:
  291. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SNORM_PACK32:
  292. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_USCALED_PACK32:
  293. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SSCALED_PACK32:
  294. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_UINT_PACK32:
  295. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SINT_PACK32:
  296. .. _class_RenderingDevice_constant_DATA_FORMAT_A8B8G8R8_SRGB_PACK32:
  297. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UNORM_PACK32:
  298. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SNORM_PACK32:
  299. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_USCALED_PACK32:
  300. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SSCALED_PACK32:
  301. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_UINT_PACK32:
  302. .. _class_RenderingDevice_constant_DATA_FORMAT_A2R10G10B10_SINT_PACK32:
  303. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UNORM_PACK32:
  304. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SNORM_PACK32:
  305. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_USCALED_PACK32:
  306. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SSCALED_PACK32:
  307. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_UINT_PACK32:
  308. .. _class_RenderingDevice_constant_DATA_FORMAT_A2B10G10R10_SINT_PACK32:
  309. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UNORM:
  310. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SNORM:
  311. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_USCALED:
  312. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SSCALED:
  313. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_UINT:
  314. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SINT:
  315. .. _class_RenderingDevice_constant_DATA_FORMAT_R16_SFLOAT:
  316. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UNORM:
  317. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SNORM:
  318. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_USCALED:
  319. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SSCALED:
  320. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_UINT:
  321. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SINT:
  322. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16_SFLOAT:
  323. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UNORM:
  324. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SNORM:
  325. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_USCALED:
  326. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SSCALED:
  327. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_UINT:
  328. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SINT:
  329. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16_SFLOAT:
  330. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UNORM:
  331. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SNORM:
  332. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_USCALED:
  333. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SSCALED:
  334. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_UINT:
  335. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SINT:
  336. .. _class_RenderingDevice_constant_DATA_FORMAT_R16G16B16A16_SFLOAT:
  337. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_UINT:
  338. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SINT:
  339. .. _class_RenderingDevice_constant_DATA_FORMAT_R32_SFLOAT:
  340. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_UINT:
  341. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SINT:
  342. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32_SFLOAT:
  343. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_UINT:
  344. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SINT:
  345. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32_SFLOAT:
  346. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_UINT:
  347. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SINT:
  348. .. _class_RenderingDevice_constant_DATA_FORMAT_R32G32B32A32_SFLOAT:
  349. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_UINT:
  350. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SINT:
  351. .. _class_RenderingDevice_constant_DATA_FORMAT_R64_SFLOAT:
  352. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_UINT:
  353. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SINT:
  354. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64_SFLOAT:
  355. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_UINT:
  356. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SINT:
  357. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64_SFLOAT:
  358. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_UINT:
  359. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SINT:
  360. .. _class_RenderingDevice_constant_DATA_FORMAT_R64G64B64A64_SFLOAT:
  361. .. _class_RenderingDevice_constant_DATA_FORMAT_B10G11R11_UFLOAT_PACK32:
  362. .. _class_RenderingDevice_constant_DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32:
  363. .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM:
  364. .. _class_RenderingDevice_constant_DATA_FORMAT_X8_D24_UNORM_PACK32:
  365. .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT:
  366. .. _class_RenderingDevice_constant_DATA_FORMAT_S8_UINT:
  367. .. _class_RenderingDevice_constant_DATA_FORMAT_D16_UNORM_S8_UINT:
  368. .. _class_RenderingDevice_constant_DATA_FORMAT_D24_UNORM_S8_UINT:
  369. .. _class_RenderingDevice_constant_DATA_FORMAT_D32_SFLOAT_S8_UINT:
  370. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_UNORM_BLOCK:
  371. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGB_SRGB_BLOCK:
  372. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_UNORM_BLOCK:
  373. .. _class_RenderingDevice_constant_DATA_FORMAT_BC1_RGBA_SRGB_BLOCK:
  374. .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_UNORM_BLOCK:
  375. .. _class_RenderingDevice_constant_DATA_FORMAT_BC2_SRGB_BLOCK:
  376. .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_UNORM_BLOCK:
  377. .. _class_RenderingDevice_constant_DATA_FORMAT_BC3_SRGB_BLOCK:
  378. .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_UNORM_BLOCK:
  379. .. _class_RenderingDevice_constant_DATA_FORMAT_BC4_SNORM_BLOCK:
  380. .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_UNORM_BLOCK:
  381. .. _class_RenderingDevice_constant_DATA_FORMAT_BC5_SNORM_BLOCK:
  382. .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_UFLOAT_BLOCK:
  383. .. _class_RenderingDevice_constant_DATA_FORMAT_BC6H_SFLOAT_BLOCK:
  384. .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_UNORM_BLOCK:
  385. .. _class_RenderingDevice_constant_DATA_FORMAT_BC7_SRGB_BLOCK:
  386. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK:
  387. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK:
  388. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK:
  389. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK:
  390. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK:
  391. .. _class_RenderingDevice_constant_DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK:
  392. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_UNORM_BLOCK:
  393. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11_SNORM_BLOCK:
  394. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_UNORM_BLOCK:
  395. .. _class_RenderingDevice_constant_DATA_FORMAT_EAC_R11G11_SNORM_BLOCK:
  396. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_UNORM_BLOCK:
  397. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_4x4_SRGB_BLOCK:
  398. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_UNORM_BLOCK:
  399. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x4_SRGB_BLOCK:
  400. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_UNORM_BLOCK:
  401. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_5x5_SRGB_BLOCK:
  402. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_UNORM_BLOCK:
  403. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x5_SRGB_BLOCK:
  404. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_UNORM_BLOCK:
  405. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_6x6_SRGB_BLOCK:
  406. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_UNORM_BLOCK:
  407. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x5_SRGB_BLOCK:
  408. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_UNORM_BLOCK:
  409. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x6_SRGB_BLOCK:
  410. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_UNORM_BLOCK:
  411. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_8x8_SRGB_BLOCK:
  412. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_UNORM_BLOCK:
  413. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x5_SRGB_BLOCK:
  414. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_UNORM_BLOCK:
  415. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x6_SRGB_BLOCK:
  416. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_UNORM_BLOCK:
  417. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x8_SRGB_BLOCK:
  418. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_UNORM_BLOCK:
  419. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_10x10_SRGB_BLOCK:
  420. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_UNORM_BLOCK:
  421. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x10_SRGB_BLOCK:
  422. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_UNORM_BLOCK:
  423. .. _class_RenderingDevice_constant_DATA_FORMAT_ASTC_12x12_SRGB_BLOCK:
  424. .. _class_RenderingDevice_constant_DATA_FORMAT_G8B8G8R8_422_UNORM:
  425. .. _class_RenderingDevice_constant_DATA_FORMAT_B8G8R8G8_422_UNORM:
  426. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM:
  427. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM:
  428. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM:
  429. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM:
  430. .. _class_RenderingDevice_constant_DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM:
  431. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6_UNORM_PACK16:
  432. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6_UNORM_2PACK16:
  433. .. _class_RenderingDevice_constant_DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16:
  434. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16:
  435. .. _class_RenderingDevice_constant_DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16:
  436. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16:
  437. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16:
  438. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16:
  439. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16:
  440. .. _class_RenderingDevice_constant_DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16:
  441. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4_UNORM_PACK16:
  442. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4_UNORM_2PACK16:
  443. .. _class_RenderingDevice_constant_DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16:
  444. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16:
  445. .. _class_RenderingDevice_constant_DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16:
  446. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16:
  447. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16:
  448. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16:
  449. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16:
  450. .. _class_RenderingDevice_constant_DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16:
  451. .. _class_RenderingDevice_constant_DATA_FORMAT_G16B16G16R16_422_UNORM:
  452. .. _class_RenderingDevice_constant_DATA_FORMAT_B16G16R16G16_422_UNORM:
  453. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM:
  454. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM:
  455. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM:
  456. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM:
  457. .. _class_RenderingDevice_constant_DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM:
  458. .. _class_RenderingDevice_constant_DATA_FORMAT_MAX:
  459. enum **DataFormat**:
  460. - **DATA_FORMAT_R4G4_UNORM_PACK8** = **0**
  461. - **DATA_FORMAT_R4G4B4A4_UNORM_PACK16** = **1**
  462. - **DATA_FORMAT_B4G4R4A4_UNORM_PACK16** = **2**
  463. - **DATA_FORMAT_R5G6B5_UNORM_PACK16** = **3**
  464. - **DATA_FORMAT_B5G6R5_UNORM_PACK16** = **4**
  465. - **DATA_FORMAT_R5G5B5A1_UNORM_PACK16** = **5**
  466. - **DATA_FORMAT_B5G5R5A1_UNORM_PACK16** = **6**
  467. - **DATA_FORMAT_A1R5G5B5_UNORM_PACK16** = **7**
  468. - **DATA_FORMAT_R8_UNORM** = **8**
  469. - **DATA_FORMAT_R8_SNORM** = **9**
  470. - **DATA_FORMAT_R8_USCALED** = **10**
  471. - **DATA_FORMAT_R8_SSCALED** = **11**
  472. - **DATA_FORMAT_R8_UINT** = **12**
  473. - **DATA_FORMAT_R8_SINT** = **13**
  474. - **DATA_FORMAT_R8_SRGB** = **14**
  475. - **DATA_FORMAT_R8G8_UNORM** = **15**
  476. - **DATA_FORMAT_R8G8_SNORM** = **16**
  477. - **DATA_FORMAT_R8G8_USCALED** = **17**
  478. - **DATA_FORMAT_R8G8_SSCALED** = **18**
  479. - **DATA_FORMAT_R8G8_UINT** = **19**
  480. - **DATA_FORMAT_R8G8_SINT** = **20**
  481. - **DATA_FORMAT_R8G8_SRGB** = **21**
  482. - **DATA_FORMAT_R8G8B8_UNORM** = **22**
  483. - **DATA_FORMAT_R8G8B8_SNORM** = **23**
  484. - **DATA_FORMAT_R8G8B8_USCALED** = **24**
  485. - **DATA_FORMAT_R8G8B8_SSCALED** = **25**
  486. - **DATA_FORMAT_R8G8B8_UINT** = **26**
  487. - **DATA_FORMAT_R8G8B8_SINT** = **27**
  488. - **DATA_FORMAT_R8G8B8_SRGB** = **28**
  489. - **DATA_FORMAT_B8G8R8_UNORM** = **29**
  490. - **DATA_FORMAT_B8G8R8_SNORM** = **30**
  491. - **DATA_FORMAT_B8G8R8_USCALED** = **31**
  492. - **DATA_FORMAT_B8G8R8_SSCALED** = **32**
  493. - **DATA_FORMAT_B8G8R8_UINT** = **33**
  494. - **DATA_FORMAT_B8G8R8_SINT** = **34**
  495. - **DATA_FORMAT_B8G8R8_SRGB** = **35**
  496. - **DATA_FORMAT_R8G8B8A8_UNORM** = **36**
  497. - **DATA_FORMAT_R8G8B8A8_SNORM** = **37**
  498. - **DATA_FORMAT_R8G8B8A8_USCALED** = **38**
  499. - **DATA_FORMAT_R8G8B8A8_SSCALED** = **39**
  500. - **DATA_FORMAT_R8G8B8A8_UINT** = **40**
  501. - **DATA_FORMAT_R8G8B8A8_SINT** = **41**
  502. - **DATA_FORMAT_R8G8B8A8_SRGB** = **42**
  503. - **DATA_FORMAT_B8G8R8A8_UNORM** = **43**
  504. - **DATA_FORMAT_B8G8R8A8_SNORM** = **44**
  505. - **DATA_FORMAT_B8G8R8A8_USCALED** = **45**
  506. - **DATA_FORMAT_B8G8R8A8_SSCALED** = **46**
  507. - **DATA_FORMAT_B8G8R8A8_UINT** = **47**
  508. - **DATA_FORMAT_B8G8R8A8_SINT** = **48**
  509. - **DATA_FORMAT_B8G8R8A8_SRGB** = **49**
  510. - **DATA_FORMAT_A8B8G8R8_UNORM_PACK32** = **50**
  511. - **DATA_FORMAT_A8B8G8R8_SNORM_PACK32** = **51**
  512. - **DATA_FORMAT_A8B8G8R8_USCALED_PACK32** = **52**
  513. - **DATA_FORMAT_A8B8G8R8_SSCALED_PACK32** = **53**
  514. - **DATA_FORMAT_A8B8G8R8_UINT_PACK32** = **54**
  515. - **DATA_FORMAT_A8B8G8R8_SINT_PACK32** = **55**
  516. - **DATA_FORMAT_A8B8G8R8_SRGB_PACK32** = **56**
  517. - **DATA_FORMAT_A2R10G10B10_UNORM_PACK32** = **57**
  518. - **DATA_FORMAT_A2R10G10B10_SNORM_PACK32** = **58**
  519. - **DATA_FORMAT_A2R10G10B10_USCALED_PACK32** = **59**
  520. - **DATA_FORMAT_A2R10G10B10_SSCALED_PACK32** = **60**
  521. - **DATA_FORMAT_A2R10G10B10_UINT_PACK32** = **61**
  522. - **DATA_FORMAT_A2R10G10B10_SINT_PACK32** = **62**
  523. - **DATA_FORMAT_A2B10G10R10_UNORM_PACK32** = **63**
  524. - **DATA_FORMAT_A2B10G10R10_SNORM_PACK32** = **64**
  525. - **DATA_FORMAT_A2B10G10R10_USCALED_PACK32** = **65**
  526. - **DATA_FORMAT_A2B10G10R10_SSCALED_PACK32** = **66**
  527. - **DATA_FORMAT_A2B10G10R10_UINT_PACK32** = **67**
  528. - **DATA_FORMAT_A2B10G10R10_SINT_PACK32** = **68**
  529. - **DATA_FORMAT_R16_UNORM** = **69**
  530. - **DATA_FORMAT_R16_SNORM** = **70**
  531. - **DATA_FORMAT_R16_USCALED** = **71**
  532. - **DATA_FORMAT_R16_SSCALED** = **72**
  533. - **DATA_FORMAT_R16_UINT** = **73**
  534. - **DATA_FORMAT_R16_SINT** = **74**
  535. - **DATA_FORMAT_R16_SFLOAT** = **75**
  536. - **DATA_FORMAT_R16G16_UNORM** = **76**
  537. - **DATA_FORMAT_R16G16_SNORM** = **77**
  538. - **DATA_FORMAT_R16G16_USCALED** = **78**
  539. - **DATA_FORMAT_R16G16_SSCALED** = **79**
  540. - **DATA_FORMAT_R16G16_UINT** = **80**
  541. - **DATA_FORMAT_R16G16_SINT** = **81**
  542. - **DATA_FORMAT_R16G16_SFLOAT** = **82**
  543. - **DATA_FORMAT_R16G16B16_UNORM** = **83**
  544. - **DATA_FORMAT_R16G16B16_SNORM** = **84**
  545. - **DATA_FORMAT_R16G16B16_USCALED** = **85**
  546. - **DATA_FORMAT_R16G16B16_SSCALED** = **86**
  547. - **DATA_FORMAT_R16G16B16_UINT** = **87**
  548. - **DATA_FORMAT_R16G16B16_SINT** = **88**
  549. - **DATA_FORMAT_R16G16B16_SFLOAT** = **89**
  550. - **DATA_FORMAT_R16G16B16A16_UNORM** = **90**
  551. - **DATA_FORMAT_R16G16B16A16_SNORM** = **91**
  552. - **DATA_FORMAT_R16G16B16A16_USCALED** = **92**
  553. - **DATA_FORMAT_R16G16B16A16_SSCALED** = **93**
  554. - **DATA_FORMAT_R16G16B16A16_UINT** = **94**
  555. - **DATA_FORMAT_R16G16B16A16_SINT** = **95**
  556. - **DATA_FORMAT_R16G16B16A16_SFLOAT** = **96**
  557. - **DATA_FORMAT_R32_UINT** = **97**
  558. - **DATA_FORMAT_R32_SINT** = **98**
  559. - **DATA_FORMAT_R32_SFLOAT** = **99**
  560. - **DATA_FORMAT_R32G32_UINT** = **100**
  561. - **DATA_FORMAT_R32G32_SINT** = **101**
  562. - **DATA_FORMAT_R32G32_SFLOAT** = **102**
  563. - **DATA_FORMAT_R32G32B32_UINT** = **103**
  564. - **DATA_FORMAT_R32G32B32_SINT** = **104**
  565. - **DATA_FORMAT_R32G32B32_SFLOAT** = **105**
  566. - **DATA_FORMAT_R32G32B32A32_UINT** = **106**
  567. - **DATA_FORMAT_R32G32B32A32_SINT** = **107**
  568. - **DATA_FORMAT_R32G32B32A32_SFLOAT** = **108**
  569. - **DATA_FORMAT_R64_UINT** = **109**
  570. - **DATA_FORMAT_R64_SINT** = **110**
  571. - **DATA_FORMAT_R64_SFLOAT** = **111**
  572. - **DATA_FORMAT_R64G64_UINT** = **112**
  573. - **DATA_FORMAT_R64G64_SINT** = **113**
  574. - **DATA_FORMAT_R64G64_SFLOAT** = **114**
  575. - **DATA_FORMAT_R64G64B64_UINT** = **115**
  576. - **DATA_FORMAT_R64G64B64_SINT** = **116**
  577. - **DATA_FORMAT_R64G64B64_SFLOAT** = **117**
  578. - **DATA_FORMAT_R64G64B64A64_UINT** = **118**
  579. - **DATA_FORMAT_R64G64B64A64_SINT** = **119**
  580. - **DATA_FORMAT_R64G64B64A64_SFLOAT** = **120**
  581. - **DATA_FORMAT_B10G11R11_UFLOAT_PACK32** = **121**
  582. - **DATA_FORMAT_E5B9G9R9_UFLOAT_PACK32** = **122**
  583. - **DATA_FORMAT_D16_UNORM** = **123**
  584. - **DATA_FORMAT_X8_D24_UNORM_PACK32** = **124**
  585. - **DATA_FORMAT_D32_SFLOAT** = **125**
  586. - **DATA_FORMAT_S8_UINT** = **126**
  587. - **DATA_FORMAT_D16_UNORM_S8_UINT** = **127**
  588. - **DATA_FORMAT_D24_UNORM_S8_UINT** = **128**
  589. - **DATA_FORMAT_D32_SFLOAT_S8_UINT** = **129**
  590. - **DATA_FORMAT_BC1_RGB_UNORM_BLOCK** = **130**
  591. - **DATA_FORMAT_BC1_RGB_SRGB_BLOCK** = **131**
  592. - **DATA_FORMAT_BC1_RGBA_UNORM_BLOCK** = **132**
  593. - **DATA_FORMAT_BC1_RGBA_SRGB_BLOCK** = **133**
  594. - **DATA_FORMAT_BC2_UNORM_BLOCK** = **134**
  595. - **DATA_FORMAT_BC2_SRGB_BLOCK** = **135**
  596. - **DATA_FORMAT_BC3_UNORM_BLOCK** = **136**
  597. - **DATA_FORMAT_BC3_SRGB_BLOCK** = **137**
  598. - **DATA_FORMAT_BC4_UNORM_BLOCK** = **138**
  599. - **DATA_FORMAT_BC4_SNORM_BLOCK** = **139**
  600. - **DATA_FORMAT_BC5_UNORM_BLOCK** = **140**
  601. - **DATA_FORMAT_BC5_SNORM_BLOCK** = **141**
  602. - **DATA_FORMAT_BC6H_UFLOAT_BLOCK** = **142**
  603. - **DATA_FORMAT_BC6H_SFLOAT_BLOCK** = **143**
  604. - **DATA_FORMAT_BC7_UNORM_BLOCK** = **144**
  605. - **DATA_FORMAT_BC7_SRGB_BLOCK** = **145**
  606. - **DATA_FORMAT_ETC2_R8G8B8_UNORM_BLOCK** = **146**
  607. - **DATA_FORMAT_ETC2_R8G8B8_SRGB_BLOCK** = **147**
  608. - **DATA_FORMAT_ETC2_R8G8B8A1_UNORM_BLOCK** = **148**
  609. - **DATA_FORMAT_ETC2_R8G8B8A1_SRGB_BLOCK** = **149**
  610. - **DATA_FORMAT_ETC2_R8G8B8A8_UNORM_BLOCK** = **150**
  611. - **DATA_FORMAT_ETC2_R8G8B8A8_SRGB_BLOCK** = **151**
  612. - **DATA_FORMAT_EAC_R11_UNORM_BLOCK** = **152**
  613. - **DATA_FORMAT_EAC_R11_SNORM_BLOCK** = **153**
  614. - **DATA_FORMAT_EAC_R11G11_UNORM_BLOCK** = **154**
  615. - **DATA_FORMAT_EAC_R11G11_SNORM_BLOCK** = **155**
  616. - **DATA_FORMAT_ASTC_4x4_UNORM_BLOCK** = **156**
  617. - **DATA_FORMAT_ASTC_4x4_SRGB_BLOCK** = **157**
  618. - **DATA_FORMAT_ASTC_5x4_UNORM_BLOCK** = **158**
  619. - **DATA_FORMAT_ASTC_5x4_SRGB_BLOCK** = **159**
  620. - **DATA_FORMAT_ASTC_5x5_UNORM_BLOCK** = **160**
  621. - **DATA_FORMAT_ASTC_5x5_SRGB_BLOCK** = **161**
  622. - **DATA_FORMAT_ASTC_6x5_UNORM_BLOCK** = **162**
  623. - **DATA_FORMAT_ASTC_6x5_SRGB_BLOCK** = **163**
  624. - **DATA_FORMAT_ASTC_6x6_UNORM_BLOCK** = **164**
  625. - **DATA_FORMAT_ASTC_6x6_SRGB_BLOCK** = **165**
  626. - **DATA_FORMAT_ASTC_8x5_UNORM_BLOCK** = **166**
  627. - **DATA_FORMAT_ASTC_8x5_SRGB_BLOCK** = **167**
  628. - **DATA_FORMAT_ASTC_8x6_UNORM_BLOCK** = **168**
  629. - **DATA_FORMAT_ASTC_8x6_SRGB_BLOCK** = **169**
  630. - **DATA_FORMAT_ASTC_8x8_UNORM_BLOCK** = **170**
  631. - **DATA_FORMAT_ASTC_8x8_SRGB_BLOCK** = **171**
  632. - **DATA_FORMAT_ASTC_10x5_UNORM_BLOCK** = **172**
  633. - **DATA_FORMAT_ASTC_10x5_SRGB_BLOCK** = **173**
  634. - **DATA_FORMAT_ASTC_10x6_UNORM_BLOCK** = **174**
  635. - **DATA_FORMAT_ASTC_10x6_SRGB_BLOCK** = **175**
  636. - **DATA_FORMAT_ASTC_10x8_UNORM_BLOCK** = **176**
  637. - **DATA_FORMAT_ASTC_10x8_SRGB_BLOCK** = **177**
  638. - **DATA_FORMAT_ASTC_10x10_UNORM_BLOCK** = **178**
  639. - **DATA_FORMAT_ASTC_10x10_SRGB_BLOCK** = **179**
  640. - **DATA_FORMAT_ASTC_12x10_UNORM_BLOCK** = **180**
  641. - **DATA_FORMAT_ASTC_12x10_SRGB_BLOCK** = **181**
  642. - **DATA_FORMAT_ASTC_12x12_UNORM_BLOCK** = **182**
  643. - **DATA_FORMAT_ASTC_12x12_SRGB_BLOCK** = **183**
  644. - **DATA_FORMAT_G8B8G8R8_422_UNORM** = **184**
  645. - **DATA_FORMAT_B8G8R8G8_422_UNORM** = **185**
  646. - **DATA_FORMAT_G8_B8_R8_3PLANE_420_UNORM** = **186**
  647. - **DATA_FORMAT_G8_B8R8_2PLANE_420_UNORM** = **187**
  648. - **DATA_FORMAT_G8_B8_R8_3PLANE_422_UNORM** = **188**
  649. - **DATA_FORMAT_G8_B8R8_2PLANE_422_UNORM** = **189**
  650. - **DATA_FORMAT_G8_B8_R8_3PLANE_444_UNORM** = **190**
  651. - **DATA_FORMAT_R10X6_UNORM_PACK16** = **191**
  652. - **DATA_FORMAT_R10X6G10X6_UNORM_2PACK16** = **192**
  653. - **DATA_FORMAT_R10X6G10X6B10X6A10X6_UNORM_4PACK16** = **193**
  654. - **DATA_FORMAT_G10X6B10X6G10X6R10X6_422_UNORM_4PACK16** = **194**
  655. - **DATA_FORMAT_B10X6G10X6R10X6G10X6_422_UNORM_4PACK16** = **195**
  656. - **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_420_UNORM_3PACK16** = **196**
  657. - **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_420_UNORM_3PACK16** = **197**
  658. - **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_422_UNORM_3PACK16** = **198**
  659. - **DATA_FORMAT_G10X6_B10X6R10X6_2PLANE_422_UNORM_3PACK16** = **199**
  660. - **DATA_FORMAT_G10X6_B10X6_R10X6_3PLANE_444_UNORM_3PACK16** = **200**
  661. - **DATA_FORMAT_R12X4_UNORM_PACK16** = **201**
  662. - **DATA_FORMAT_R12X4G12X4_UNORM_2PACK16** = **202**
  663. - **DATA_FORMAT_R12X4G12X4B12X4A12X4_UNORM_4PACK16** = **203**
  664. - **DATA_FORMAT_G12X4B12X4G12X4R12X4_422_UNORM_4PACK16** = **204**
  665. - **DATA_FORMAT_B12X4G12X4R12X4G12X4_422_UNORM_4PACK16** = **205**
  666. - **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_420_UNORM_3PACK16** = **206**
  667. - **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_420_UNORM_3PACK16** = **207**
  668. - **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_422_UNORM_3PACK16** = **208**
  669. - **DATA_FORMAT_G12X4_B12X4R12X4_2PLANE_422_UNORM_3PACK16** = **209**
  670. - **DATA_FORMAT_G12X4_B12X4_R12X4_3PLANE_444_UNORM_3PACK16** = **210**
  671. - **DATA_FORMAT_G16B16G16R16_422_UNORM** = **211**
  672. - **DATA_FORMAT_B16G16R16G16_422_UNORM** = **212**
  673. - **DATA_FORMAT_G16_B16_R16_3PLANE_420_UNORM** = **213**
  674. - **DATA_FORMAT_G16_B16R16_2PLANE_420_UNORM** = **214**
  675. - **DATA_FORMAT_G16_B16_R16_3PLANE_422_UNORM** = **215**
  676. - **DATA_FORMAT_G16_B16R16_2PLANE_422_UNORM** = **216**
  677. - **DATA_FORMAT_G16_B16_R16_3PLANE_444_UNORM** = **217**
  678. - **DATA_FORMAT_MAX** = **218**
  679. ----
  680. .. _enum_RenderingDevice_TextureType:
  681. .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D:
  682. .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D:
  683. .. _class_RenderingDevice_constant_TEXTURE_TYPE_3D:
  684. .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE:
  685. .. _class_RenderingDevice_constant_TEXTURE_TYPE_1D_ARRAY:
  686. .. _class_RenderingDevice_constant_TEXTURE_TYPE_2D_ARRAY:
  687. .. _class_RenderingDevice_constant_TEXTURE_TYPE_CUBE_ARRAY:
  688. .. _class_RenderingDevice_constant_TEXTURE_TYPE_MAX:
  689. enum **TextureType**:
  690. - **TEXTURE_TYPE_1D** = **0**
  691. - **TEXTURE_TYPE_2D** = **1**
  692. - **TEXTURE_TYPE_3D** = **2**
  693. - **TEXTURE_TYPE_CUBE** = **3**
  694. - **TEXTURE_TYPE_1D_ARRAY** = **4**
  695. - **TEXTURE_TYPE_2D_ARRAY** = **5**
  696. - **TEXTURE_TYPE_CUBE_ARRAY** = **6**
  697. - **TEXTURE_TYPE_MAX** = **7**
  698. ----
  699. .. _enum_RenderingDevice_TextureSamples:
  700. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_1:
  701. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_2:
  702. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_4:
  703. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_8:
  704. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_16:
  705. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_32:
  706. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_64:
  707. .. _class_RenderingDevice_constant_TEXTURE_SAMPLES_MAX:
  708. enum **TextureSamples**:
  709. - **TEXTURE_SAMPLES_1** = **0**
  710. - **TEXTURE_SAMPLES_2** = **1**
  711. - **TEXTURE_SAMPLES_4** = **2**
  712. - **TEXTURE_SAMPLES_8** = **3**
  713. - **TEXTURE_SAMPLES_16** = **4**
  714. - **TEXTURE_SAMPLES_32** = **5**
  715. - **TEXTURE_SAMPLES_64** = **6**
  716. - **TEXTURE_SAMPLES_MAX** = **7**
  717. ----
  718. .. _enum_RenderingDevice_TextureUsageBits:
  719. .. _class_RenderingDevice_constant_TEXTURE_USAGE_SAMPLING_BIT:
  720. .. _class_RenderingDevice_constant_TEXTURE_USAGE_COLOR_ATTACHMENT_BIT:
  721. .. _class_RenderingDevice_constant_TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT:
  722. .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_BIT:
  723. .. _class_RenderingDevice_constant_TEXTURE_USAGE_STORAGE_ATOMIC_BIT:
  724. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CPU_READ_BIT:
  725. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_UPDATE_BIT:
  726. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_FROM_BIT:
  727. .. _class_RenderingDevice_constant_TEXTURE_USAGE_CAN_COPY_TO_BIT:
  728. .. _class_RenderingDevice_constant_TEXTURE_USAGE_INPUT_ATTACHMENT_BIT:
  729. enum **TextureUsageBits**:
  730. - **TEXTURE_USAGE_SAMPLING_BIT** = **1**
  731. - **TEXTURE_USAGE_COLOR_ATTACHMENT_BIT** = **2**
  732. - **TEXTURE_USAGE_DEPTH_STENCIL_ATTACHMENT_BIT** = **4**
  733. - **TEXTURE_USAGE_STORAGE_BIT** = **8**
  734. - **TEXTURE_USAGE_STORAGE_ATOMIC_BIT** = **16**
  735. - **TEXTURE_USAGE_CPU_READ_BIT** = **32**
  736. - **TEXTURE_USAGE_CAN_UPDATE_BIT** = **64**
  737. - **TEXTURE_USAGE_CAN_COPY_FROM_BIT** = **128**
  738. - **TEXTURE_USAGE_CAN_COPY_TO_BIT** = **256**
  739. - **TEXTURE_USAGE_INPUT_ATTACHMENT_BIT** = **512**
  740. ----
  741. .. _enum_RenderingDevice_TextureSwizzle:
  742. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_IDENTITY:
  743. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ZERO:
  744. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_ONE:
  745. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_R:
  746. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_G:
  747. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_B:
  748. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_A:
  749. .. _class_RenderingDevice_constant_TEXTURE_SWIZZLE_MAX:
  750. enum **TextureSwizzle**:
  751. - **TEXTURE_SWIZZLE_IDENTITY** = **0**
  752. - **TEXTURE_SWIZZLE_ZERO** = **1**
  753. - **TEXTURE_SWIZZLE_ONE** = **2**
  754. - **TEXTURE_SWIZZLE_R** = **3**
  755. - **TEXTURE_SWIZZLE_G** = **4**
  756. - **TEXTURE_SWIZZLE_B** = **5**
  757. - **TEXTURE_SWIZZLE_A** = **6**
  758. - **TEXTURE_SWIZZLE_MAX** = **7**
  759. ----
  760. .. _enum_RenderingDevice_TextureSliceType:
  761. .. _class_RenderingDevice_constant_TEXTURE_SLICE_2D:
  762. .. _class_RenderingDevice_constant_TEXTURE_SLICE_CUBEMAP:
  763. .. _class_RenderingDevice_constant_TEXTURE_SLICE_3D:
  764. enum **TextureSliceType**:
  765. - **TEXTURE_SLICE_2D** = **0**
  766. - **TEXTURE_SLICE_CUBEMAP** = **1**
  767. - **TEXTURE_SLICE_3D** = **2**
  768. ----
  769. .. _enum_RenderingDevice_SamplerFilter:
  770. .. _class_RenderingDevice_constant_SAMPLER_FILTER_NEAREST:
  771. .. _class_RenderingDevice_constant_SAMPLER_FILTER_LINEAR:
  772. enum **SamplerFilter**:
  773. - **SAMPLER_FILTER_NEAREST** = **0**
  774. - **SAMPLER_FILTER_LINEAR** = **1**
  775. ----
  776. .. _enum_RenderingDevice_SamplerRepeatMode:
  777. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_REPEAT:
  778. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRRORED_REPEAT:
  779. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE:
  780. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER:
  781. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE:
  782. .. _class_RenderingDevice_constant_SAMPLER_REPEAT_MODE_MAX:
  783. enum **SamplerRepeatMode**:
  784. - **SAMPLER_REPEAT_MODE_REPEAT** = **0**
  785. - **SAMPLER_REPEAT_MODE_MIRRORED_REPEAT** = **1**
  786. - **SAMPLER_REPEAT_MODE_CLAMP_TO_EDGE** = **2**
  787. - **SAMPLER_REPEAT_MODE_CLAMP_TO_BORDER** = **3**
  788. - **SAMPLER_REPEAT_MODE_MIRROR_CLAMP_TO_EDGE** = **4**
  789. - **SAMPLER_REPEAT_MODE_MAX** = **5**
  790. ----
  791. .. _enum_RenderingDevice_SamplerBorderColor:
  792. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK:
  793. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK:
  794. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK:
  795. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK:
  796. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE:
  797. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE:
  798. .. _class_RenderingDevice_constant_SAMPLER_BORDER_COLOR_MAX:
  799. enum **SamplerBorderColor**:
  800. - **SAMPLER_BORDER_COLOR_FLOAT_TRANSPARENT_BLACK** = **0**
  801. - **SAMPLER_BORDER_COLOR_INT_TRANSPARENT_BLACK** = **1**
  802. - **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_BLACK** = **2**
  803. - **SAMPLER_BORDER_COLOR_INT_OPAQUE_BLACK** = **3**
  804. - **SAMPLER_BORDER_COLOR_FLOAT_OPAQUE_WHITE** = **4**
  805. - **SAMPLER_BORDER_COLOR_INT_OPAQUE_WHITE** = **5**
  806. - **SAMPLER_BORDER_COLOR_MAX** = **6**
  807. ----
  808. .. _enum_RenderingDevice_VertexFrequency:
  809. .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_VERTEX:
  810. .. _class_RenderingDevice_constant_VERTEX_FREQUENCY_INSTANCE:
  811. enum **VertexFrequency**:
  812. - **VERTEX_FREQUENCY_VERTEX** = **0**
  813. - **VERTEX_FREQUENCY_INSTANCE** = **1**
  814. ----
  815. .. _enum_RenderingDevice_IndexBufferFormat:
  816. .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT16:
  817. .. _class_RenderingDevice_constant_INDEX_BUFFER_FORMAT_UINT32:
  818. enum **IndexBufferFormat**:
  819. - **INDEX_BUFFER_FORMAT_UINT16** = **0**
  820. - **INDEX_BUFFER_FORMAT_UINT32** = **1**
  821. ----
  822. .. _enum_RenderingDevice_StorageBufferUsage:
  823. .. _class_RenderingDevice_constant_STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT:
  824. enum **StorageBufferUsage**:
  825. - **STORAGE_BUFFER_USAGE_DISPATCH_INDIRECT** = **1**
  826. ----
  827. .. _enum_RenderingDevice_UniformType:
  828. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER:
  829. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE:
  830. .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE:
  831. .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE:
  832. .. _class_RenderingDevice_constant_UNIFORM_TYPE_TEXTURE_BUFFER:
  833. .. _class_RenderingDevice_constant_UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER:
  834. .. _class_RenderingDevice_constant_UNIFORM_TYPE_IMAGE_BUFFER:
  835. .. _class_RenderingDevice_constant_UNIFORM_TYPE_UNIFORM_BUFFER:
  836. .. _class_RenderingDevice_constant_UNIFORM_TYPE_STORAGE_BUFFER:
  837. .. _class_RenderingDevice_constant_UNIFORM_TYPE_INPUT_ATTACHMENT:
  838. .. _class_RenderingDevice_constant_UNIFORM_TYPE_MAX:
  839. enum **UniformType**:
  840. - **UNIFORM_TYPE_SAMPLER** = **0**
  841. - **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE** = **1**
  842. - **UNIFORM_TYPE_TEXTURE** = **2**
  843. - **UNIFORM_TYPE_IMAGE** = **3**
  844. - **UNIFORM_TYPE_TEXTURE_BUFFER** = **4**
  845. - **UNIFORM_TYPE_SAMPLER_WITH_TEXTURE_BUFFER** = **5**
  846. - **UNIFORM_TYPE_IMAGE_BUFFER** = **6**
  847. - **UNIFORM_TYPE_UNIFORM_BUFFER** = **7**
  848. - **UNIFORM_TYPE_STORAGE_BUFFER** = **8**
  849. - **UNIFORM_TYPE_INPUT_ATTACHMENT** = **9**
  850. - **UNIFORM_TYPE_MAX** = **10**
  851. ----
  852. .. _enum_RenderingDevice_RenderPrimitive:
  853. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_POINTS:
  854. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES:
  855. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINES_WITH_ADJACENCY:
  856. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS:
  857. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY:
  858. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES:
  859. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY:
  860. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS:
  861. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY:
  862. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX:
  863. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_TESSELATION_PATCH:
  864. .. _class_RenderingDevice_constant_RENDER_PRIMITIVE_MAX:
  865. enum **RenderPrimitive**:
  866. - **RENDER_PRIMITIVE_POINTS** = **0**
  867. - **RENDER_PRIMITIVE_LINES** = **1**
  868. - **RENDER_PRIMITIVE_LINES_WITH_ADJACENCY** = **2**
  869. - **RENDER_PRIMITIVE_LINESTRIPS** = **3**
  870. - **RENDER_PRIMITIVE_LINESTRIPS_WITH_ADJACENCY** = **4**
  871. - **RENDER_PRIMITIVE_TRIANGLES** = **5**
  872. - **RENDER_PRIMITIVE_TRIANGLES_WITH_ADJACENCY** = **6**
  873. - **RENDER_PRIMITIVE_TRIANGLE_STRIPS** = **7**
  874. - **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_AJACENCY** = **8**
  875. - **RENDER_PRIMITIVE_TRIANGLE_STRIPS_WITH_RESTART_INDEX** = **9**
  876. - **RENDER_PRIMITIVE_TESSELATION_PATCH** = **10**
  877. - **RENDER_PRIMITIVE_MAX** = **11**
  878. ----
  879. .. _enum_RenderingDevice_PolygonCullMode:
  880. .. _class_RenderingDevice_constant_POLYGON_CULL_DISABLED:
  881. .. _class_RenderingDevice_constant_POLYGON_CULL_FRONT:
  882. .. _class_RenderingDevice_constant_POLYGON_CULL_BACK:
  883. enum **PolygonCullMode**:
  884. - **POLYGON_CULL_DISABLED** = **0**
  885. - **POLYGON_CULL_FRONT** = **1**
  886. - **POLYGON_CULL_BACK** = **2**
  887. ----
  888. .. _enum_RenderingDevice_PolygonFrontFace:
  889. .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_CLOCKWISE:
  890. .. _class_RenderingDevice_constant_POLYGON_FRONT_FACE_COUNTER_CLOCKWISE:
  891. enum **PolygonFrontFace**:
  892. - **POLYGON_FRONT_FACE_CLOCKWISE** = **0**
  893. - **POLYGON_FRONT_FACE_COUNTER_CLOCKWISE** = **1**
  894. ----
  895. .. _enum_RenderingDevice_StencilOperation:
  896. .. _class_RenderingDevice_constant_STENCIL_OP_KEEP:
  897. .. _class_RenderingDevice_constant_STENCIL_OP_ZERO:
  898. .. _class_RenderingDevice_constant_STENCIL_OP_REPLACE:
  899. .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_CLAMP:
  900. .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_CLAMP:
  901. .. _class_RenderingDevice_constant_STENCIL_OP_INVERT:
  902. .. _class_RenderingDevice_constant_STENCIL_OP_INCREMENT_AND_WRAP:
  903. .. _class_RenderingDevice_constant_STENCIL_OP_DECREMENT_AND_WRAP:
  904. .. _class_RenderingDevice_constant_STENCIL_OP_MAX:
  905. enum **StencilOperation**:
  906. - **STENCIL_OP_KEEP** = **0**
  907. - **STENCIL_OP_ZERO** = **1**
  908. - **STENCIL_OP_REPLACE** = **2**
  909. - **STENCIL_OP_INCREMENT_AND_CLAMP** = **3**
  910. - **STENCIL_OP_DECREMENT_AND_CLAMP** = **4**
  911. - **STENCIL_OP_INVERT** = **5**
  912. - **STENCIL_OP_INCREMENT_AND_WRAP** = **6**
  913. - **STENCIL_OP_DECREMENT_AND_WRAP** = **7**
  914. - **STENCIL_OP_MAX** = **8**
  915. ----
  916. .. _enum_RenderingDevice_CompareOperator:
  917. .. _class_RenderingDevice_constant_COMPARE_OP_NEVER:
  918. .. _class_RenderingDevice_constant_COMPARE_OP_LESS:
  919. .. _class_RenderingDevice_constant_COMPARE_OP_EQUAL:
  920. .. _class_RenderingDevice_constant_COMPARE_OP_LESS_OR_EQUAL:
  921. .. _class_RenderingDevice_constant_COMPARE_OP_GREATER:
  922. .. _class_RenderingDevice_constant_COMPARE_OP_NOT_EQUAL:
  923. .. _class_RenderingDevice_constant_COMPARE_OP_GREATER_OR_EQUAL:
  924. .. _class_RenderingDevice_constant_COMPARE_OP_ALWAYS:
  925. .. _class_RenderingDevice_constant_COMPARE_OP_MAX:
  926. enum **CompareOperator**:
  927. - **COMPARE_OP_NEVER** = **0**
  928. - **COMPARE_OP_LESS** = **1**
  929. - **COMPARE_OP_EQUAL** = **2**
  930. - **COMPARE_OP_LESS_OR_EQUAL** = **3**
  931. - **COMPARE_OP_GREATER** = **4**
  932. - **COMPARE_OP_NOT_EQUAL** = **5**
  933. - **COMPARE_OP_GREATER_OR_EQUAL** = **6**
  934. - **COMPARE_OP_ALWAYS** = **7**
  935. - **COMPARE_OP_MAX** = **8**
  936. ----
  937. .. _enum_RenderingDevice_LogicOperation:
  938. .. _class_RenderingDevice_constant_LOGIC_OP_CLEAR:
  939. .. _class_RenderingDevice_constant_LOGIC_OP_AND:
  940. .. _class_RenderingDevice_constant_LOGIC_OP_AND_REVERSE:
  941. .. _class_RenderingDevice_constant_LOGIC_OP_COPY:
  942. .. _class_RenderingDevice_constant_LOGIC_OP_AND_INVERTED:
  943. .. _class_RenderingDevice_constant_LOGIC_OP_NO_OP:
  944. .. _class_RenderingDevice_constant_LOGIC_OP_XOR:
  945. .. _class_RenderingDevice_constant_LOGIC_OP_OR:
  946. .. _class_RenderingDevice_constant_LOGIC_OP_NOR:
  947. .. _class_RenderingDevice_constant_LOGIC_OP_EQUIVALENT:
  948. .. _class_RenderingDevice_constant_LOGIC_OP_INVERT:
  949. .. _class_RenderingDevice_constant_LOGIC_OP_OR_REVERSE:
  950. .. _class_RenderingDevice_constant_LOGIC_OP_COPY_INVERTED:
  951. .. _class_RenderingDevice_constant_LOGIC_OP_OR_INVERTED:
  952. .. _class_RenderingDevice_constant_LOGIC_OP_NAND:
  953. .. _class_RenderingDevice_constant_LOGIC_OP_SET:
  954. .. _class_RenderingDevice_constant_LOGIC_OP_MAX:
  955. enum **LogicOperation**:
  956. - **LOGIC_OP_CLEAR** = **0**
  957. - **LOGIC_OP_AND** = **1**
  958. - **LOGIC_OP_AND_REVERSE** = **2**
  959. - **LOGIC_OP_COPY** = **3**
  960. - **LOGIC_OP_AND_INVERTED** = **4**
  961. - **LOGIC_OP_NO_OP** = **5**
  962. - **LOGIC_OP_XOR** = **6**
  963. - **LOGIC_OP_OR** = **7**
  964. - **LOGIC_OP_NOR** = **8**
  965. - **LOGIC_OP_EQUIVALENT** = **9**
  966. - **LOGIC_OP_INVERT** = **10**
  967. - **LOGIC_OP_OR_REVERSE** = **11**
  968. - **LOGIC_OP_COPY_INVERTED** = **12**
  969. - **LOGIC_OP_OR_INVERTED** = **13**
  970. - **LOGIC_OP_NAND** = **14**
  971. - **LOGIC_OP_SET** = **15**
  972. - **LOGIC_OP_MAX** = **16**
  973. ----
  974. .. _enum_RenderingDevice_BlendFactor:
  975. .. _class_RenderingDevice_constant_BLEND_FACTOR_ZERO:
  976. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE:
  977. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_COLOR:
  978. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_COLOR:
  979. .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_COLOR:
  980. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_COLOR:
  981. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA:
  982. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA:
  983. .. _class_RenderingDevice_constant_BLEND_FACTOR_DST_ALPHA:
  984. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_DST_ALPHA:
  985. .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_COLOR:
  986. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR:
  987. .. _class_RenderingDevice_constant_BLEND_FACTOR_CONSTANT_ALPHA:
  988. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA:
  989. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC_ALPHA_SATURATE:
  990. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_COLOR:
  991. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_COLOR:
  992. .. _class_RenderingDevice_constant_BLEND_FACTOR_SRC1_ALPHA:
  993. .. _class_RenderingDevice_constant_BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA:
  994. .. _class_RenderingDevice_constant_BLEND_FACTOR_MAX:
  995. enum **BlendFactor**:
  996. - **BLEND_FACTOR_ZERO** = **0**
  997. - **BLEND_FACTOR_ONE** = **1**
  998. - **BLEND_FACTOR_SRC_COLOR** = **2**
  999. - **BLEND_FACTOR_ONE_MINUS_SRC_COLOR** = **3**
  1000. - **BLEND_FACTOR_DST_COLOR** = **4**
  1001. - **BLEND_FACTOR_ONE_MINUS_DST_COLOR** = **5**
  1002. - **BLEND_FACTOR_SRC_ALPHA** = **6**
  1003. - **BLEND_FACTOR_ONE_MINUS_SRC_ALPHA** = **7**
  1004. - **BLEND_FACTOR_DST_ALPHA** = **8**
  1005. - **BLEND_FACTOR_ONE_MINUS_DST_ALPHA** = **9**
  1006. - **BLEND_FACTOR_CONSTANT_COLOR** = **10**
  1007. - **BLEND_FACTOR_ONE_MINUS_CONSTANT_COLOR** = **11**
  1008. - **BLEND_FACTOR_CONSTANT_ALPHA** = **12**
  1009. - **BLEND_FACTOR_ONE_MINUS_CONSTANT_ALPHA** = **13**
  1010. - **BLEND_FACTOR_SRC_ALPHA_SATURATE** = **14**
  1011. - **BLEND_FACTOR_SRC1_COLOR** = **15**
  1012. - **BLEND_FACTOR_ONE_MINUS_SRC1_COLOR** = **16**
  1013. - **BLEND_FACTOR_SRC1_ALPHA** = **17**
  1014. - **BLEND_FACTOR_ONE_MINUS_SRC1_ALPHA** = **18**
  1015. - **BLEND_FACTOR_MAX** = **19**
  1016. ----
  1017. .. _enum_RenderingDevice_BlendOperation:
  1018. .. _class_RenderingDevice_constant_BLEND_OP_ADD:
  1019. .. _class_RenderingDevice_constant_BLEND_OP_SUBTRACT:
  1020. .. _class_RenderingDevice_constant_BLEND_OP_REVERSE_SUBTRACT:
  1021. .. _class_RenderingDevice_constant_BLEND_OP_MINIMUM:
  1022. .. _class_RenderingDevice_constant_BLEND_OP_MAXIMUM:
  1023. .. _class_RenderingDevice_constant_BLEND_OP_MAX:
  1024. enum **BlendOperation**:
  1025. - **BLEND_OP_ADD** = **0**
  1026. - **BLEND_OP_SUBTRACT** = **1**
  1027. - **BLEND_OP_REVERSE_SUBTRACT** = **2**
  1028. - **BLEND_OP_MINIMUM** = **3**
  1029. - **BLEND_OP_MAXIMUM** = **4**
  1030. - **BLEND_OP_MAX** = **5**
  1031. ----
  1032. .. _enum_RenderingDevice_PipelineDynamicStateFlags:
  1033. .. _class_RenderingDevice_constant_DYNAMIC_STATE_LINE_WIDTH:
  1034. .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BIAS:
  1035. .. _class_RenderingDevice_constant_DYNAMIC_STATE_BLEND_CONSTANTS:
  1036. .. _class_RenderingDevice_constant_DYNAMIC_STATE_DEPTH_BOUNDS:
  1037. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_COMPARE_MASK:
  1038. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_WRITE_MASK:
  1039. .. _class_RenderingDevice_constant_DYNAMIC_STATE_STENCIL_REFERENCE:
  1040. enum **PipelineDynamicStateFlags**:
  1041. - **DYNAMIC_STATE_LINE_WIDTH** = **1**
  1042. - **DYNAMIC_STATE_DEPTH_BIAS** = **2**
  1043. - **DYNAMIC_STATE_BLEND_CONSTANTS** = **4**
  1044. - **DYNAMIC_STATE_DEPTH_BOUNDS** = **8**
  1045. - **DYNAMIC_STATE_STENCIL_COMPARE_MASK** = **16**
  1046. - **DYNAMIC_STATE_STENCIL_WRITE_MASK** = **32**
  1047. - **DYNAMIC_STATE_STENCIL_REFERENCE** = **64**
  1048. ----
  1049. .. _enum_RenderingDevice_InitialAction:
  1050. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR:
  1051. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION:
  1052. .. _class_RenderingDevice_constant_INITIAL_ACTION_CLEAR_REGION_CONTINUE:
  1053. .. _class_RenderingDevice_constant_INITIAL_ACTION_KEEP:
  1054. .. _class_RenderingDevice_constant_INITIAL_ACTION_DROP:
  1055. .. _class_RenderingDevice_constant_INITIAL_ACTION_CONTINUE:
  1056. .. _class_RenderingDevice_constant_INITIAL_ACTION_MAX:
  1057. enum **InitialAction**:
  1058. - **INITIAL_ACTION_CLEAR** = **0**
  1059. - **INITIAL_ACTION_CLEAR_REGION** = **1**
  1060. - **INITIAL_ACTION_CLEAR_REGION_CONTINUE** = **2**
  1061. - **INITIAL_ACTION_KEEP** = **3**
  1062. - **INITIAL_ACTION_DROP** = **4**
  1063. - **INITIAL_ACTION_CONTINUE** = **5**
  1064. - **INITIAL_ACTION_MAX** = **6**
  1065. ----
  1066. .. _enum_RenderingDevice_FinalAction:
  1067. .. _class_RenderingDevice_constant_FINAL_ACTION_READ:
  1068. .. _class_RenderingDevice_constant_FINAL_ACTION_DISCARD:
  1069. .. _class_RenderingDevice_constant_FINAL_ACTION_CONTINUE:
  1070. .. _class_RenderingDevice_constant_FINAL_ACTION_MAX:
  1071. enum **FinalAction**:
  1072. - **FINAL_ACTION_READ** = **0**
  1073. - **FINAL_ACTION_DISCARD** = **1**
  1074. - **FINAL_ACTION_CONTINUE** = **2**
  1075. - **FINAL_ACTION_MAX** = **3**
  1076. ----
  1077. .. _enum_RenderingDevice_ShaderStage:
  1078. .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX:
  1079. .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT:
  1080. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL:
  1081. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION:
  1082. .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE:
  1083. .. _class_RenderingDevice_constant_SHADER_STAGE_MAX:
  1084. .. _class_RenderingDevice_constant_SHADER_STAGE_VERTEX_BIT:
  1085. .. _class_RenderingDevice_constant_SHADER_STAGE_FRAGMENT_BIT:
  1086. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_CONTROL_BIT:
  1087. .. _class_RenderingDevice_constant_SHADER_STAGE_TESSELATION_EVALUATION_BIT:
  1088. .. _class_RenderingDevice_constant_SHADER_STAGE_COMPUTE_BIT:
  1089. enum **ShaderStage**:
  1090. - **SHADER_STAGE_VERTEX** = **0**
  1091. - **SHADER_STAGE_FRAGMENT** = **1**
  1092. - **SHADER_STAGE_TESSELATION_CONTROL** = **2**
  1093. - **SHADER_STAGE_TESSELATION_EVALUATION** = **3**
  1094. - **SHADER_STAGE_COMPUTE** = **4**
  1095. - **SHADER_STAGE_MAX** = **5**
  1096. - **SHADER_STAGE_VERTEX_BIT** = **1**
  1097. - **SHADER_STAGE_FRAGMENT_BIT** = **2**
  1098. - **SHADER_STAGE_TESSELATION_CONTROL_BIT** = **4**
  1099. - **SHADER_STAGE_TESSELATION_EVALUATION_BIT** = **8**
  1100. - **SHADER_STAGE_COMPUTE_BIT** = **16**
  1101. ----
  1102. .. _enum_RenderingDevice_ShaderLanguage:
  1103. .. _class_RenderingDevice_constant_SHADER_LANGUAGE_GLSL:
  1104. .. _class_RenderingDevice_constant_SHADER_LANGUAGE_HLSL:
  1105. enum **ShaderLanguage**:
  1106. - **SHADER_LANGUAGE_GLSL** = **0**
  1107. - **SHADER_LANGUAGE_HLSL** = **1**
  1108. ----
  1109. .. _enum_RenderingDevice_PipelineSpecializationConstantType:
  1110. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL:
  1111. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT:
  1112. .. _class_RenderingDevice_constant_PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT:
  1113. enum **PipelineSpecializationConstantType**:
  1114. - **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_BOOL** = **0**
  1115. - **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_INT** = **1**
  1116. - **PIPELINE_SPECIALIZATION_CONSTANT_TYPE_FLOAT** = **2**
  1117. ----
  1118. .. _enum_RenderingDevice_Limit:
  1119. .. _class_RenderingDevice_constant_LIMIT_MAX_BOUND_UNIFORM_SETS:
  1120. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS:
  1121. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_UNIFORM_SET:
  1122. .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET:
  1123. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET:
  1124. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET:
  1125. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET:
  1126. .. _class_RenderingDevice_constant_LIMIT_MAX_DRAW_INDEXED_INDEX:
  1127. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_HEIGHT:
  1128. .. _class_RenderingDevice_constant_LIMIT_MAX_FRAMEBUFFER_WIDTH:
  1129. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_ARRAY_LAYERS:
  1130. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_1D:
  1131. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_2D:
  1132. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_3D:
  1133. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURE_SIZE_CUBE:
  1134. .. _class_RenderingDevice_constant_LIMIT_MAX_TEXTURES_PER_SHADER_STAGE:
  1135. .. _class_RenderingDevice_constant_LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE:
  1136. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE:
  1137. .. _class_RenderingDevice_constant_LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE:
  1138. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE:
  1139. .. _class_RenderingDevice_constant_LIMIT_MAX_PUSH_CONSTANT_SIZE:
  1140. .. _class_RenderingDevice_constant_LIMIT_MAX_UNIFORM_BUFFER_SIZE:
  1141. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET:
  1142. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES:
  1143. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDINGS:
  1144. .. _class_RenderingDevice_constant_LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE:
  1145. .. _class_RenderingDevice_constant_LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT:
  1146. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE:
  1147. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X:
  1148. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y:
  1149. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z:
  1150. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS:
  1151. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X:
  1152. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y:
  1153. .. _class_RenderingDevice_constant_LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z:
  1154. enum **Limit**:
  1155. - **LIMIT_MAX_BOUND_UNIFORM_SETS** = **0**
  1156. - **LIMIT_MAX_FRAMEBUFFER_COLOR_ATTACHMENTS** = **1**
  1157. - **LIMIT_MAX_TEXTURES_PER_UNIFORM_SET** = **2**
  1158. - **LIMIT_MAX_SAMPLERS_PER_UNIFORM_SET** = **3**
  1159. - **LIMIT_MAX_STORAGE_BUFFERS_PER_UNIFORM_SET** = **4**
  1160. - **LIMIT_MAX_STORAGE_IMAGES_PER_UNIFORM_SET** = **5**
  1161. - **LIMIT_MAX_UNIFORM_BUFFERS_PER_UNIFORM_SET** = **6**
  1162. - **LIMIT_MAX_DRAW_INDEXED_INDEX** = **7**
  1163. - **LIMIT_MAX_FRAMEBUFFER_HEIGHT** = **8**
  1164. - **LIMIT_MAX_FRAMEBUFFER_WIDTH** = **9**
  1165. - **LIMIT_MAX_TEXTURE_ARRAY_LAYERS** = **10**
  1166. - **LIMIT_MAX_TEXTURE_SIZE_1D** = **11**
  1167. - **LIMIT_MAX_TEXTURE_SIZE_2D** = **12**
  1168. - **LIMIT_MAX_TEXTURE_SIZE_3D** = **13**
  1169. - **LIMIT_MAX_TEXTURE_SIZE_CUBE** = **14**
  1170. - **LIMIT_MAX_TEXTURES_PER_SHADER_STAGE** = **15**
  1171. - **LIMIT_MAX_SAMPLERS_PER_SHADER_STAGE** = **16**
  1172. - **LIMIT_MAX_STORAGE_BUFFERS_PER_SHADER_STAGE** = **17**
  1173. - **LIMIT_MAX_STORAGE_IMAGES_PER_SHADER_STAGE** = **18**
  1174. - **LIMIT_MAX_UNIFORM_BUFFERS_PER_SHADER_STAGE** = **19**
  1175. - **LIMIT_MAX_PUSH_CONSTANT_SIZE** = **20**
  1176. - **LIMIT_MAX_UNIFORM_BUFFER_SIZE** = **21**
  1177. - **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTE_OFFSET** = **22**
  1178. - **LIMIT_MAX_VERTEX_INPUT_ATTRIBUTES** = **23**
  1179. - **LIMIT_MAX_VERTEX_INPUT_BINDINGS** = **24**
  1180. - **LIMIT_MAX_VERTEX_INPUT_BINDING_STRIDE** = **25**
  1181. - **LIMIT_MIN_UNIFORM_BUFFER_OFFSET_ALIGNMENT** = **26**
  1182. - **LIMIT_MAX_COMPUTE_SHARED_MEMORY_SIZE** = **27**
  1183. - **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_X** = **28**
  1184. - **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Y** = **29**
  1185. - **LIMIT_MAX_COMPUTE_WORKGROUP_COUNT_Z** = **30**
  1186. - **LIMIT_MAX_COMPUTE_WORKGROUP_INVOCATIONS** = **31**
  1187. - **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_X** = **32**
  1188. - **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Y** = **33**
  1189. - **LIMIT_MAX_COMPUTE_WORKGROUP_SIZE_Z** = **34**
  1190. ----
  1191. .. _enum_RenderingDevice_MemoryType:
  1192. .. _class_RenderingDevice_constant_MEMORY_TEXTURES:
  1193. .. _class_RenderingDevice_constant_MEMORY_BUFFERS:
  1194. .. _class_RenderingDevice_constant_MEMORY_TOTAL:
  1195. enum **MemoryType**:
  1196. - **MEMORY_TEXTURES** = **0**
  1197. - **MEMORY_BUFFERS** = **1**
  1198. - **MEMORY_TOTAL** = **2**
  1199. Constants
  1200. ---------
  1201. .. _class_RenderingDevice_constant_BARRIER_MASK_RASTER:
  1202. .. _class_RenderingDevice_constant_BARRIER_MASK_COMPUTE:
  1203. .. _class_RenderingDevice_constant_BARRIER_MASK_TRANSFER:
  1204. .. _class_RenderingDevice_constant_BARRIER_MASK_ALL:
  1205. .. _class_RenderingDevice_constant_BARRIER_MASK_NO_BARRIER:
  1206. .. _class_RenderingDevice_constant_INVALID_ID:
  1207. .. _class_RenderingDevice_constant_INVALID_FORMAT_ID:
  1208. - **BARRIER_MASK_RASTER** = **1**
  1209. - **BARRIER_MASK_COMPUTE** = **2**
  1210. - **BARRIER_MASK_TRANSFER** = **4**
  1211. - **BARRIER_MASK_ALL** = **7**
  1212. - **BARRIER_MASK_NO_BARRIER** = **8**
  1213. - **INVALID_ID** = **-1**
  1214. - **INVALID_FORMAT_ID** = **-1**
  1215. Method Descriptions
  1216. -------------------
  1217. .. _class_RenderingDevice_method_barrier:
  1218. - void **barrier** **(** :ref:`int<class_int>` from=7, :ref:`int<class_int>` to=7 **)**
  1219. ----
  1220. .. _class_RenderingDevice_method_buffer_clear:
  1221. - :ref:`Error<enum_@GlobalScope_Error>` **buffer_clear** **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset, :ref:`int<class_int>` size_bytes, :ref:`int<class_int>` post_barrier=7 **)**
  1222. ----
  1223. .. _class_RenderingDevice_method_buffer_get_data:
  1224. - :ref:`PackedByteArray<class_PackedByteArray>` **buffer_get_data** **(** :ref:`RID<class_RID>` buffer **)**
  1225. ----
  1226. .. _class_RenderingDevice_method_buffer_update:
  1227. - :ref:`Error<enum_@GlobalScope_Error>` **buffer_update** **(** :ref:`RID<class_RID>` buffer, :ref:`int<class_int>` offset, :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data, :ref:`int<class_int>` post_barrier=7 **)**
  1228. ----
  1229. .. _class_RenderingDevice_method_capture_timestamp:
  1230. - void **capture_timestamp** **(** :ref:`String<class_String>` name **)**
  1231. ----
  1232. .. _class_RenderingDevice_method_compute_list_add_barrier:
  1233. - void **compute_list_add_barrier** **(** :ref:`int<class_int>` compute_list **)**
  1234. ----
  1235. .. _class_RenderingDevice_method_compute_list_begin:
  1236. - :ref:`int<class_int>` **compute_list_begin** **(** :ref:`bool<class_bool>` allow_draw_overlap=false **)**
  1237. ----
  1238. .. _class_RenderingDevice_method_compute_list_bind_compute_pipeline:
  1239. - void **compute_list_bind_compute_pipeline** **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` compute_pipeline **)**
  1240. ----
  1241. .. _class_RenderingDevice_method_compute_list_bind_uniform_set:
  1242. - void **compute_list_bind_uniform_set** **(** :ref:`int<class_int>` compute_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)**
  1243. ----
  1244. .. _class_RenderingDevice_method_compute_list_dispatch:
  1245. - void **compute_list_dispatch** **(** :ref:`int<class_int>` compute_list, :ref:`int<class_int>` x_groups, :ref:`int<class_int>` y_groups, :ref:`int<class_int>` z_groups **)**
  1246. ----
  1247. .. _class_RenderingDevice_method_compute_list_end:
  1248. - void **compute_list_end** **(** :ref:`int<class_int>` post_barrier=7 **)**
  1249. ----
  1250. .. _class_RenderingDevice_method_compute_list_set_push_constant:
  1251. - void **compute_list_set_push_constant** **(** :ref:`int<class_int>` compute_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)**
  1252. ----
  1253. .. _class_RenderingDevice_method_compute_pipeline_create:
  1254. - :ref:`RID<class_RID>` **compute_pipeline_create** **(** :ref:`RID<class_RID>` shader, :ref:`RDPipelineSpecializationConstant[]<class_RDPipelineSpecializationConstant>` specialization_constants=[] **)**
  1255. ----
  1256. .. _class_RenderingDevice_method_compute_pipeline_is_valid:
  1257. - :ref:`bool<class_bool>` **compute_pipeline_is_valid** **(** :ref:`RID<class_RID>` compute_pieline **)**
  1258. ----
  1259. .. _class_RenderingDevice_method_create_local_device:
  1260. - :ref:`RenderingDevice<class_RenderingDevice>` **create_local_device** **(** **)**
  1261. ----
  1262. .. _class_RenderingDevice_method_draw_command_begin_label:
  1263. - void **draw_command_begin_label** **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)**
  1264. ----
  1265. .. _class_RenderingDevice_method_draw_command_end_label:
  1266. - void **draw_command_end_label** **(** **)**
  1267. ----
  1268. .. _class_RenderingDevice_method_draw_command_insert_label:
  1269. - void **draw_command_insert_label** **(** :ref:`String<class_String>` name, :ref:`Color<class_Color>` color **)**
  1270. ----
  1271. .. _class_RenderingDevice_method_draw_list_begin:
  1272. - :ref:`int<class_int>` **draw_list_begin** **(** :ref:`RID<class_RID>` framebuffer, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_color_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_color_action, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_depth_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_depth_action, :ref:`PackedColorArray<class_PackedColorArray>` clear_color_values=PackedColorArray(), :ref:`float<class_float>` clear_depth=1.0, :ref:`int<class_int>` clear_stencil=0, :ref:`Rect2<class_Rect2>` region=Rect2(0, 0, 0, 0), :ref:`Array<class_Array>` storage_textures=[] **)**
  1273. ----
  1274. .. _class_RenderingDevice_method_draw_list_begin_for_screen:
  1275. - :ref:`int<class_int>` **draw_list_begin_for_screen** **(** :ref:`int<class_int>` screen=0, :ref:`Color<class_Color>` clear_color=Color(0, 0, 0, 1) **)**
  1276. ----
  1277. .. _class_RenderingDevice_method_draw_list_begin_split:
  1278. - :ref:`PackedInt64Array<class_PackedInt64Array>` **draw_list_begin_split** **(** :ref:`RID<class_RID>` framebuffer, :ref:`int<class_int>` splits, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_color_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_color_action, :ref:`InitialAction<enum_RenderingDevice_InitialAction>` initial_depth_action, :ref:`FinalAction<enum_RenderingDevice_FinalAction>` final_depth_action, :ref:`PackedColorArray<class_PackedColorArray>` clear_color_values=PackedColorArray(), :ref:`float<class_float>` clear_depth=1.0, :ref:`int<class_int>` clear_stencil=0, :ref:`Rect2<class_Rect2>` region=Rect2(0, 0, 0, 0), :ref:`RID[]<class_RID>` storage_textures=[] **)**
  1279. ----
  1280. .. _class_RenderingDevice_method_draw_list_bind_index_array:
  1281. - void **draw_list_bind_index_array** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` index_array **)**
  1282. ----
  1283. .. _class_RenderingDevice_method_draw_list_bind_render_pipeline:
  1284. - void **draw_list_bind_render_pipeline** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` render_pipeline **)**
  1285. ----
  1286. .. _class_RenderingDevice_method_draw_list_bind_uniform_set:
  1287. - void **draw_list_bind_uniform_set** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` uniform_set, :ref:`int<class_int>` set_index **)**
  1288. ----
  1289. .. _class_RenderingDevice_method_draw_list_bind_vertex_array:
  1290. - void **draw_list_bind_vertex_array** **(** :ref:`int<class_int>` draw_list, :ref:`RID<class_RID>` vertex_array **)**
  1291. ----
  1292. .. _class_RenderingDevice_method_draw_list_disable_scissor:
  1293. - void **draw_list_disable_scissor** **(** :ref:`int<class_int>` draw_list **)**
  1294. ----
  1295. .. _class_RenderingDevice_method_draw_list_draw:
  1296. - void **draw_list_draw** **(** :ref:`int<class_int>` draw_list, :ref:`bool<class_bool>` use_indices, :ref:`int<class_int>` instances, :ref:`int<class_int>` procedural_vertex_count=0 **)**
  1297. ----
  1298. .. _class_RenderingDevice_method_draw_list_enable_scissor:
  1299. - void **draw_list_enable_scissor** **(** :ref:`int<class_int>` draw_list, :ref:`Rect2<class_Rect2>` rect=Rect2(0, 0, 0, 0) **)**
  1300. ----
  1301. .. _class_RenderingDevice_method_draw_list_end:
  1302. - void **draw_list_end** **(** :ref:`int<class_int>` post_barrier=7 **)**
  1303. ----
  1304. .. _class_RenderingDevice_method_draw_list_set_blend_constants:
  1305. - void **draw_list_set_blend_constants** **(** :ref:`int<class_int>` draw_list, :ref:`Color<class_Color>` color **)**
  1306. Sets blend constants for draw list, blend constants are used only if the graphics pipeline is created with ``DYNAMIC_STATE_BLEND_CONSTANTS`` flag set.
  1307. ----
  1308. .. _class_RenderingDevice_method_draw_list_set_push_constant:
  1309. - void **draw_list_set_push_constant** **(** :ref:`int<class_int>` draw_list, :ref:`PackedByteArray<class_PackedByteArray>` buffer, :ref:`int<class_int>` size_bytes **)**
  1310. ----
  1311. .. _class_RenderingDevice_method_draw_list_switch_to_next_pass:
  1312. - :ref:`int<class_int>` **draw_list_switch_to_next_pass** **(** **)**
  1313. ----
  1314. .. _class_RenderingDevice_method_draw_list_switch_to_next_pass_split:
  1315. - :ref:`PackedInt64Array<class_PackedInt64Array>` **draw_list_switch_to_next_pass_split** **(** :ref:`int<class_int>` splits **)**
  1316. ----
  1317. .. _class_RenderingDevice_method_framebuffer_create:
  1318. - :ref:`RID<class_RID>` **framebuffer_create** **(** :ref:`RID[]<class_RID>` textures, :ref:`int<class_int>` validate_with_format=-1, :ref:`int<class_int>` view_count=1 **)**
  1319. ----
  1320. .. _class_RenderingDevice_method_framebuffer_create_empty:
  1321. - :ref:`RID<class_RID>` **framebuffer_create_empty** **(** :ref:`Vector2i<class_Vector2i>` size, :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples=0, :ref:`int<class_int>` validate_with_format=-1 **)**
  1322. ----
  1323. .. _class_RenderingDevice_method_framebuffer_create_multipass:
  1324. - :ref:`RID<class_RID>` **framebuffer_create_multipass** **(** :ref:`RID[]<class_RID>` textures, :ref:`RDFramebufferPass[]<class_RDFramebufferPass>` passes, :ref:`int<class_int>` validate_with_format=-1, :ref:`int<class_int>` view_count=1 **)**
  1325. ----
  1326. .. _class_RenderingDevice_method_framebuffer_format_create:
  1327. - :ref:`int<class_int>` **framebuffer_format_create** **(** :ref:`RDAttachmentFormat[]<class_RDAttachmentFormat>` attachments, :ref:`int<class_int>` view_count=1 **)**
  1328. ----
  1329. .. _class_RenderingDevice_method_framebuffer_format_create_empty:
  1330. - :ref:`int<class_int>` **framebuffer_format_create_empty** **(** :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` samples=0 **)**
  1331. ----
  1332. .. _class_RenderingDevice_method_framebuffer_format_create_multipass:
  1333. - :ref:`int<class_int>` **framebuffer_format_create_multipass** **(** :ref:`RDAttachmentFormat[]<class_RDAttachmentFormat>` attachments, :ref:`RDFramebufferPass[]<class_RDFramebufferPass>` passes, :ref:`int<class_int>` view_count=1 **)**
  1334. ----
  1335. .. _class_RenderingDevice_method_framebuffer_format_get_texture_samples:
  1336. - :ref:`TextureSamples<enum_RenderingDevice_TextureSamples>` **framebuffer_format_get_texture_samples** **(** :ref:`int<class_int>` format, :ref:`int<class_int>` render_pass=0 **)**
  1337. ----
  1338. .. _class_RenderingDevice_method_framebuffer_get_format:
  1339. - :ref:`int<class_int>` **framebuffer_get_format** **(** :ref:`RID<class_RID>` framebuffer **)**
  1340. ----
  1341. .. _class_RenderingDevice_method_framebuffer_is_valid:
  1342. - :ref:`bool<class_bool>` **framebuffer_is_valid** **(** :ref:`RID<class_RID>` framebuffer **)** |const|
  1343. ----
  1344. .. _class_RenderingDevice_method_free_rid:
  1345. - void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  1346. ----
  1347. .. _class_RenderingDevice_method_full_barrier:
  1348. - void **full_barrier** **(** **)**
  1349. ----
  1350. .. _class_RenderingDevice_method_get_captured_timestamp_cpu_time:
  1351. - :ref:`int<class_int>` **get_captured_timestamp_cpu_time** **(** :ref:`int<class_int>` index **)** |const|
  1352. ----
  1353. .. _class_RenderingDevice_method_get_captured_timestamp_gpu_time:
  1354. - :ref:`int<class_int>` **get_captured_timestamp_gpu_time** **(** :ref:`int<class_int>` index **)** |const|
  1355. ----
  1356. .. _class_RenderingDevice_method_get_captured_timestamp_name:
  1357. - :ref:`String<class_String>` **get_captured_timestamp_name** **(** :ref:`int<class_int>` index **)** |const|
  1358. ----
  1359. .. _class_RenderingDevice_method_get_captured_timestamps_count:
  1360. - :ref:`int<class_int>` **get_captured_timestamps_count** **(** **)** |const|
  1361. ----
  1362. .. _class_RenderingDevice_method_get_captured_timestamps_frame:
  1363. - :ref:`int<class_int>` **get_captured_timestamps_frame** **(** **)** |const|
  1364. ----
  1365. .. _class_RenderingDevice_method_get_device_name:
  1366. - :ref:`String<class_String>` **get_device_name** **(** **)** |const|
  1367. ----
  1368. .. _class_RenderingDevice_method_get_device_pipeline_cache_uuid:
  1369. - :ref:`String<class_String>` **get_device_pipeline_cache_uuid** **(** **)** |const|
  1370. ----
  1371. .. _class_RenderingDevice_method_get_device_vendor_name:
  1372. - :ref:`String<class_String>` **get_device_vendor_name** **(** **)** |const|
  1373. ----
  1374. .. _class_RenderingDevice_method_get_driver_resource:
  1375. - :ref:`int<class_int>` **get_driver_resource** **(** :ref:`DriverResource<enum_RenderingDevice_DriverResource>` resource, :ref:`RID<class_RID>` rid, :ref:`int<class_int>` index **)**
  1376. ----
  1377. .. _class_RenderingDevice_method_get_frame_delay:
  1378. - :ref:`int<class_int>` **get_frame_delay** **(** **)** |const|
  1379. ----
  1380. .. _class_RenderingDevice_method_get_memory_usage:
  1381. - :ref:`int<class_int>` **get_memory_usage** **(** :ref:`MemoryType<enum_RenderingDevice_MemoryType>` type **)** |const|
  1382. ----
  1383. .. _class_RenderingDevice_method_index_array_create:
  1384. - :ref:`RID<class_RID>` **index_array_create** **(** :ref:`RID<class_RID>` index_buffer, :ref:`int<class_int>` index_offset, :ref:`int<class_int>` index_count **)**
  1385. ----
  1386. .. _class_RenderingDevice_method_index_buffer_create:
  1387. - :ref:`RID<class_RID>` **index_buffer_create** **(** :ref:`int<class_int>` size_indices, :ref:`IndexBufferFormat<enum_RenderingDevice_IndexBufferFormat>` format, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`bool<class_bool>` use_restart_indices=false **)**
  1388. ----
  1389. .. _class_RenderingDevice_method_limit_get:
  1390. - :ref:`int<class_int>` **limit_get** **(** :ref:`Limit<enum_RenderingDevice_Limit>` limit **)** |const|
  1391. ----
  1392. .. _class_RenderingDevice_method_render_pipeline_create:
  1393. - :ref:`RID<class_RID>` **render_pipeline_create** **(** :ref:`RID<class_RID>` shader, :ref:`int<class_int>` framebuffer_format, :ref:`int<class_int>` vertex_format, :ref:`RenderPrimitive<enum_RenderingDevice_RenderPrimitive>` primitive, :ref:`RDPipelineRasterizationState<class_RDPipelineRasterizationState>` rasterization_state, :ref:`RDPipelineMultisampleState<class_RDPipelineMultisampleState>` multisample_state, :ref:`RDPipelineDepthStencilState<class_RDPipelineDepthStencilState>` stencil_state, :ref:`RDPipelineColorBlendState<class_RDPipelineColorBlendState>` color_blend_state, :ref:`int<class_int>` dynamic_state_flags=0, :ref:`int<class_int>` for_render_pass=0, :ref:`RDPipelineSpecializationConstant[]<class_RDPipelineSpecializationConstant>` specialization_constants=[] **)**
  1394. ----
  1395. .. _class_RenderingDevice_method_render_pipeline_is_valid:
  1396. - :ref:`bool<class_bool>` **render_pipeline_is_valid** **(** :ref:`RID<class_RID>` render_pipeline **)**
  1397. ----
  1398. .. _class_RenderingDevice_method_sampler_create:
  1399. - :ref:`RID<class_RID>` **sampler_create** **(** :ref:`RDSamplerState<class_RDSamplerState>` state **)**
  1400. ----
  1401. .. _class_RenderingDevice_method_screen_get_framebuffer_format:
  1402. - :ref:`int<class_int>` **screen_get_framebuffer_format** **(** **)** |const|
  1403. ----
  1404. .. _class_RenderingDevice_method_screen_get_height:
  1405. - :ref:`int<class_int>` **screen_get_height** **(** :ref:`int<class_int>` screen=0 **)** |const|
  1406. ----
  1407. .. _class_RenderingDevice_method_screen_get_width:
  1408. - :ref:`int<class_int>` **screen_get_width** **(** :ref:`int<class_int>` screen=0 **)** |const|
  1409. ----
  1410. .. _class_RenderingDevice_method_set_resource_name:
  1411. - void **set_resource_name** **(** :ref:`RID<class_RID>` id, :ref:`String<class_String>` name **)**
  1412. ----
  1413. .. _class_RenderingDevice_method_shader_compile_binary_from_spirv:
  1414. - :ref:`PackedByteArray<class_PackedByteArray>` **shader_compile_binary_from_spirv** **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)**
  1415. ----
  1416. .. _class_RenderingDevice_method_shader_compile_spirv_from_source:
  1417. - :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` **shader_compile_spirv_from_source** **(** :ref:`RDShaderSource<class_RDShaderSource>` shader_source, :ref:`bool<class_bool>` allow_cache=true **)**
  1418. ----
  1419. .. _class_RenderingDevice_method_shader_create_from_bytecode:
  1420. - :ref:`RID<class_RID>` **shader_create_from_bytecode** **(** :ref:`PackedByteArray<class_PackedByteArray>` binary_data **)**
  1421. ----
  1422. .. _class_RenderingDevice_method_shader_create_from_spirv:
  1423. - :ref:`RID<class_RID>` **shader_create_from_spirv** **(** :ref:`RDShaderSPIRV<class_RDShaderSPIRV>` spirv_data, :ref:`String<class_String>` name="" **)**
  1424. ----
  1425. .. _class_RenderingDevice_method_shader_get_vertex_input_attribute_mask:
  1426. - :ref:`int<class_int>` **shader_get_vertex_input_attribute_mask** **(** :ref:`RID<class_RID>` shader **)**
  1427. ----
  1428. .. _class_RenderingDevice_method_storage_buffer_create:
  1429. - :ref:`RID<class_RID>` **storage_buffer_create** **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`int<class_int>` usage=0 **)**
  1430. ----
  1431. .. _class_RenderingDevice_method_submit:
  1432. - void **submit** **(** **)**
  1433. ----
  1434. .. _class_RenderingDevice_method_sync:
  1435. - void **sync** **(** **)**
  1436. ----
  1437. .. _class_RenderingDevice_method_texture_buffer_create:
  1438. - :ref:`RID<class_RID>` **texture_buffer_create** **(** :ref:`int<class_int>` size_bytes, :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray() **)**
  1439. ----
  1440. .. _class_RenderingDevice_method_texture_clear:
  1441. - :ref:`Error<enum_@GlobalScope_Error>` **texture_clear** **(** :ref:`RID<class_RID>` texture, :ref:`Color<class_Color>` color, :ref:`int<class_int>` base_mipmap, :ref:`int<class_int>` mipmap_count, :ref:`int<class_int>` base_layer, :ref:`int<class_int>` layer_count, :ref:`int<class_int>` post_barrier=7 **)**
  1442. ----
  1443. .. _class_RenderingDevice_method_texture_copy:
  1444. - :ref:`Error<enum_@GlobalScope_Error>` **texture_copy** **(** :ref:`RID<class_RID>` from_texture, :ref:`RID<class_RID>` to_texture, :ref:`Vector3<class_Vector3>` from_pos, :ref:`Vector3<class_Vector3>` to_pos, :ref:`Vector3<class_Vector3>` size, :ref:`int<class_int>` src_mipmap, :ref:`int<class_int>` dst_mipmap, :ref:`int<class_int>` src_layer, :ref:`int<class_int>` dst_layer, :ref:`int<class_int>` post_barrier=7 **)**
  1445. ----
  1446. .. _class_RenderingDevice_method_texture_create:
  1447. - :ref:`RID<class_RID>` **texture_create** **(** :ref:`RDTextureFormat<class_RDTextureFormat>` format, :ref:`RDTextureView<class_RDTextureView>` view, :ref:`PackedByteArray[]<class_PackedByteArray>` data=[] **)**
  1448. ----
  1449. .. _class_RenderingDevice_method_texture_create_shared:
  1450. - :ref:`RID<class_RID>` **texture_create_shared** **(** :ref:`RDTextureView<class_RDTextureView>` view, :ref:`RID<class_RID>` with_texture **)**
  1451. ----
  1452. .. _class_RenderingDevice_method_texture_create_shared_from_slice:
  1453. - :ref:`RID<class_RID>` **texture_create_shared_from_slice** **(** :ref:`RDTextureView<class_RDTextureView>` view, :ref:`RID<class_RID>` with_texture, :ref:`int<class_int>` layer, :ref:`int<class_int>` mipmap, :ref:`int<class_int>` mipmaps=1, :ref:`TextureSliceType<enum_RenderingDevice_TextureSliceType>` slice_type=0 **)**
  1454. ----
  1455. .. _class_RenderingDevice_method_texture_get_data:
  1456. - :ref:`PackedByteArray<class_PackedByteArray>` **texture_get_data** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer **)**
  1457. ----
  1458. .. _class_RenderingDevice_method_texture_is_format_supported_for_usage:
  1459. - :ref:`bool<class_bool>` **texture_is_format_supported_for_usage** **(** :ref:`DataFormat<enum_RenderingDevice_DataFormat>` format, :ref:`int<class_int>` usage_flags **)** |const|
  1460. ----
  1461. .. _class_RenderingDevice_method_texture_is_shared:
  1462. - :ref:`bool<class_bool>` **texture_is_shared** **(** :ref:`RID<class_RID>` texture **)**
  1463. ----
  1464. .. _class_RenderingDevice_method_texture_is_valid:
  1465. - :ref:`bool<class_bool>` **texture_is_valid** **(** :ref:`RID<class_RID>` texture **)**
  1466. ----
  1467. .. _class_RenderingDevice_method_texture_resolve_multisample:
  1468. - :ref:`Error<enum_@GlobalScope_Error>` **texture_resolve_multisample** **(** :ref:`RID<class_RID>` from_texture, :ref:`RID<class_RID>` to_texture, :ref:`int<class_int>` post_barrier=7 **)**
  1469. ----
  1470. .. _class_RenderingDevice_method_texture_update:
  1471. - :ref:`Error<enum_@GlobalScope_Error>` **texture_update** **(** :ref:`RID<class_RID>` texture, :ref:`int<class_int>` layer, :ref:`PackedByteArray<class_PackedByteArray>` data, :ref:`int<class_int>` post_barrier=7 **)**
  1472. ----
  1473. .. _class_RenderingDevice_method_uniform_buffer_create:
  1474. - :ref:`RID<class_RID>` **uniform_buffer_create** **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray() **)**
  1475. ----
  1476. .. _class_RenderingDevice_method_uniform_set_create:
  1477. - :ref:`RID<class_RID>` **uniform_set_create** **(** :ref:`RDUniform[]<class_RDUniform>` uniforms, :ref:`RID<class_RID>` shader, :ref:`int<class_int>` shader_set **)**
  1478. ----
  1479. .. _class_RenderingDevice_method_uniform_set_is_valid:
  1480. - :ref:`bool<class_bool>` **uniform_set_is_valid** **(** :ref:`RID<class_RID>` uniform_set **)**
  1481. ----
  1482. .. _class_RenderingDevice_method_vertex_buffer_create:
  1483. - :ref:`RID<class_RID>` **vertex_buffer_create** **(** :ref:`int<class_int>` size_bytes, :ref:`PackedByteArray<class_PackedByteArray>` data=PackedByteArray(), :ref:`bool<class_bool>` use_as_storage=false **)**
  1484. ----
  1485. .. _class_RenderingDevice_method_vertex_format_create:
  1486. - :ref:`int<class_int>` **vertex_format_create** **(** :ref:`RDVertexAttribute[]<class_RDVertexAttribute>` vertex_descriptions **)**
  1487. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  1488. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  1489. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  1490. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  1491. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  1492. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`