class_visualserver.rst 242 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the VisualServer.xml source instead.
  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
  4. .. _class_VisualServer:
  5. VisualServer
  6. ============
  7. **Inherits:** :ref:`Object<class_object>`
  8. **Category:** Core
  9. Brief Description
  10. -----------------
  11. Server for anything visible.
  12. Member Functions
  13. ----------------
  14. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  15. | void | :ref:`black_bars_set_images<class_VisualServer_black_bars_set_images>` **(** :ref:`RID<class_rid>` left, :ref:`RID<class_rid>` top, :ref:`RID<class_rid>` right, :ref:`RID<class_rid>` bottom **)** |
  16. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  17. | void | :ref:`black_bars_set_margins<class_VisualServer_black_bars_set_margins>` **(** :ref:`int<class_int>` left, :ref:`int<class_int>` top, :ref:`int<class_int>` right, :ref:`int<class_int>` bottom **)** |
  18. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  19. | :ref:`RID<class_rid>` | :ref:`canvas_create<class_VisualServer_canvas_create>` **(** **)** |
  20. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  21. | void | :ref:`canvas_item_add_circle<class_VisualServer_canvas_item_add_circle>` **(** :ref:`RID<class_rid>` item, :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)** |
  22. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  23. | void | :ref:`canvas_item_add_clip_ignore<class_VisualServer_canvas_item_add_clip_ignore>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` ignore **)** |
  24. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  25. | void | :ref:`canvas_item_add_line<class_VisualServer_canvas_item_add_line>` **(** :ref:`RID<class_rid>` item, :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
  26. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  27. | void | :ref:`canvas_item_add_mesh<class_VisualServer_canvas_item_add_mesh>` **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` mesh, :ref:`RID<class_rid>` skeleton **)** |
  28. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | void | :ref:`canvas_item_add_multimesh<class_VisualServer_canvas_item_add_multimesh>` **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` mesh, :ref:`RID<class_rid>` skeleton **)** |
  30. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | void | :ref:`canvas_item_add_nine_patch<class_VisualServer_canvas_item_add_nine_patch>` **(** :ref:`RID<class_rid>` item, :ref:`Rect2<class_rect2>` rect, :ref:`Rect2<class_rect2>` source, :ref:`RID<class_rid>` texture, :ref:`Vector2<class_vector2>` topleft, :ref:`Vector2<class_vector2>` bottomright, :ref:`int<class_int>` x_axis_mode=0, :ref:`int<class_int>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`RID<class_rid>` normal_map **)** |
  32. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | void | :ref:`canvas_item_add_particles<class_VisualServer_canvas_item_add_particles>` **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` particles, :ref:`RID<class_rid>` texture, :ref:`RID<class_rid>` normal_map, :ref:`int<class_int>` h_frames, :ref:`int<class_int>` v_frames **)** |
  34. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | void | :ref:`canvas_item_add_polygon<class_VisualServer_canvas_item_add_polygon>` **(** :ref:`RID<class_rid>` item, :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs=PoolVector2Array( ), :ref:`RID<class_rid>` texture, :ref:`RID<class_rid>` normal_map, :ref:`bool<class_bool>` antialiased=false **)** |
  36. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | void | :ref:`canvas_item_add_polyline<class_VisualServer_canvas_item_add_polyline>` **(** :ref:`RID<class_rid>` item, :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)** |
  38. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | void | :ref:`canvas_item_add_primitive<class_VisualServer_canvas_item_add_primitive>` **(** :ref:`RID<class_rid>` item, :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs, :ref:`RID<class_rid>` texture, :ref:`float<class_float>` width=1.0, :ref:`RID<class_rid>` normal_map **)** |
  40. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | void | :ref:`canvas_item_add_rect<class_VisualServer_canvas_item_add_rect>` **(** :ref:`RID<class_rid>` item, :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color **)** |
  42. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | void | :ref:`canvas_item_add_set_transform<class_VisualServer_canvas_item_add_set_transform>` **(** :ref:`RID<class_rid>` item, :ref:`Transform2D<class_transform2d>` transform **)** |
  44. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | void | :ref:`canvas_item_add_texture_rect<class_VisualServer_canvas_item_add_texture_rect>` **(** :ref:`RID<class_rid>` item, :ref:`Rect2<class_rect2>` rect, :ref:`RID<class_rid>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`RID<class_rid>` normal_map **)** |
  46. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | void | :ref:`canvas_item_add_texture_rect_region<class_VisualServer_canvas_item_add_texture_rect_region>` **(** :ref:`RID<class_rid>` item, :ref:`Rect2<class_rect2>` rect, :ref:`RID<class_rid>` texture, :ref:`Rect2<class_rect2>` src_rect, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`RID<class_rid>` normal_map, :ref:`bool<class_bool>` clip_uv=true **)** |
  48. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | void | :ref:`canvas_item_add_triangle_array<class_VisualServer_canvas_item_add_triangle_array>` **(** :ref:`RID<class_rid>` item, :ref:`PoolIntArray<class_poolintarray>` indices, :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs=PoolVector2Array( ), :ref:`RID<class_rid>` texture, :ref:`int<class_int>` count=-1, :ref:`RID<class_rid>` normal_map **)** |
  50. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | void | :ref:`canvas_item_clear<class_VisualServer_canvas_item_clear>` **(** :ref:`RID<class_rid>` item **)** |
  52. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`RID<class_rid>` | :ref:`canvas_item_create<class_VisualServer_canvas_item_create>` **(** **)** |
  54. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | void | :ref:`canvas_item_set_clip<class_VisualServer_canvas_item_set_clip>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` clip **)** |
  56. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | void | :ref:`canvas_item_set_copy_to_backbuffer<class_VisualServer_canvas_item_set_copy_to_backbuffer>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_rect2>` rect **)** |
  58. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | void | :ref:`canvas_item_set_custom_rect<class_VisualServer_canvas_item_set_custom_rect>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_rect2>` rect=Rect2( 0, 0, 0, 0 ) **)** |
  60. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | void | :ref:`canvas_item_set_distance_field_mode<class_VisualServer_canvas_item_set_distance_field_mode>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)** |
  62. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | void | :ref:`canvas_item_set_draw_behind_parent<class_VisualServer_canvas_item_set_draw_behind_parent>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)** |
  64. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | void | :ref:`canvas_item_set_draw_index<class_VisualServer_canvas_item_set_draw_index>` **(** :ref:`RID<class_rid>` item, :ref:`int<class_int>` index **)** |
  66. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | void | :ref:`canvas_item_set_light_mask<class_VisualServer_canvas_item_set_light_mask>` **(** :ref:`RID<class_rid>` item, :ref:`int<class_int>` mask **)** |
  68. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | void | :ref:`canvas_item_set_material<class_VisualServer_canvas_item_set_material>` **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` material **)** |
  70. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | void | :ref:`canvas_item_set_modulate<class_VisualServer_canvas_item_set_modulate>` **(** :ref:`RID<class_rid>` item, :ref:`Color<class_color>` color **)** |
  72. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | void | :ref:`canvas_item_set_parent<class_VisualServer_canvas_item_set_parent>` **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` parent **)** |
  74. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | void | :ref:`canvas_item_set_self_modulate<class_VisualServer_canvas_item_set_self_modulate>` **(** :ref:`RID<class_rid>` item, :ref:`Color<class_color>` color **)** |
  76. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | void | :ref:`canvas_item_set_sort_children_by_y<class_VisualServer_canvas_item_set_sort_children_by_y>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)** |
  78. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | void | :ref:`canvas_item_set_transform<class_VisualServer_canvas_item_set_transform>` **(** :ref:`RID<class_rid>` item, :ref:`Transform2D<class_transform2d>` transform **)** |
  80. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | void | :ref:`canvas_item_set_use_parent_material<class_VisualServer_canvas_item_set_use_parent_material>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)** |
  82. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | void | :ref:`canvas_item_set_visible<class_VisualServer_canvas_item_set_visible>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` visible **)** |
  84. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | void | :ref:`canvas_item_set_z_as_relative_to_parent<class_VisualServer_canvas_item_set_z_as_relative_to_parent>` **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)** |
  86. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | void | :ref:`canvas_item_set_z_index<class_VisualServer_canvas_item_set_z_index>` **(** :ref:`RID<class_rid>` item, :ref:`int<class_int>` z_index **)** |
  88. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | void | :ref:`canvas_light_attach_to_canvas<class_VisualServer_canvas_light_attach_to_canvas>` **(** :ref:`RID<class_rid>` light, :ref:`RID<class_rid>` canvas **)** |
  90. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`RID<class_rid>` | :ref:`canvas_light_create<class_VisualServer_canvas_light_create>` **(** **)** |
  92. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | void | :ref:`canvas_light_occluder_attach_to_canvas<class_VisualServer_canvas_light_occluder_attach_to_canvas>` **(** :ref:`RID<class_rid>` occluder, :ref:`RID<class_rid>` canvas **)** |
  94. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`RID<class_rid>` | :ref:`canvas_light_occluder_create<class_VisualServer_canvas_light_occluder_create>` **(** **)** |
  96. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | void | :ref:`canvas_light_occluder_set_enabled<class_VisualServer_canvas_light_occluder_set_enabled>` **(** :ref:`RID<class_rid>` occluder, :ref:`bool<class_bool>` enabled **)** |
  98. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | void | :ref:`canvas_light_occluder_set_light_mask<class_VisualServer_canvas_light_occluder_set_light_mask>` **(** :ref:`RID<class_rid>` occluder, :ref:`int<class_int>` mask **)** |
  100. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | void | :ref:`canvas_light_occluder_set_polygon<class_VisualServer_canvas_light_occluder_set_polygon>` **(** :ref:`RID<class_rid>` occluder, :ref:`RID<class_rid>` polygon **)** |
  102. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | void | :ref:`canvas_light_occluder_set_transform<class_VisualServer_canvas_light_occluder_set_transform>` **(** :ref:`RID<class_rid>` occluder, :ref:`Transform2D<class_transform2d>` transform **)** |
  104. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | void | :ref:`canvas_light_set_color<class_VisualServer_canvas_light_set_color>` **(** :ref:`RID<class_rid>` light, :ref:`Color<class_color>` color **)** |
  106. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | void | :ref:`canvas_light_set_enabled<class_VisualServer_canvas_light_set_enabled>` **(** :ref:`RID<class_rid>` light, :ref:`bool<class_bool>` enabled **)** |
  108. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | void | :ref:`canvas_light_set_energy<class_VisualServer_canvas_light_set_energy>` **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` energy **)** |
  110. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | void | :ref:`canvas_light_set_height<class_VisualServer_canvas_light_set_height>` **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` height **)** |
  112. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | void | :ref:`canvas_light_set_item_cull_mask<class_VisualServer_canvas_light_set_item_cull_mask>` **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` mask **)** |
  114. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | void | :ref:`canvas_light_set_item_shadow_cull_mask<class_VisualServer_canvas_light_set_item_shadow_cull_mask>` **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` mask **)** |
  116. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | void | :ref:`canvas_light_set_layer_range<class_VisualServer_canvas_light_set_layer_range>` **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)** |
  118. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | void | :ref:`canvas_light_set_mode<class_VisualServer_canvas_light_set_mode>` **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` mode **)** |
  120. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | void | :ref:`canvas_light_set_scale<class_VisualServer_canvas_light_set_scale>` **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` scale **)** |
  122. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | void | :ref:`canvas_light_set_shadow_buffer_size<class_VisualServer_canvas_light_set_shadow_buffer_size>` **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` size **)** |
  124. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | void | :ref:`canvas_light_set_shadow_color<class_VisualServer_canvas_light_set_shadow_color>` **(** :ref:`RID<class_rid>` light, :ref:`Color<class_color>` color **)** |
  126. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | void | :ref:`canvas_light_set_shadow_enabled<class_VisualServer_canvas_light_set_shadow_enabled>` **(** :ref:`RID<class_rid>` light, :ref:`bool<class_bool>` enabled **)** |
  128. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | void | :ref:`canvas_light_set_shadow_filter<class_VisualServer_canvas_light_set_shadow_filter>` **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` filter **)** |
  130. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | void | :ref:`canvas_light_set_shadow_gradient_length<class_VisualServer_canvas_light_set_shadow_gradient_length>` **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` length **)** |
  132. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | void | :ref:`canvas_light_set_shadow_smooth<class_VisualServer_canvas_light_set_shadow_smooth>` **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` smooth **)** |
  134. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | void | :ref:`canvas_light_set_texture<class_VisualServer_canvas_light_set_texture>` **(** :ref:`RID<class_rid>` light, :ref:`RID<class_rid>` texture **)** |
  136. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | void | :ref:`canvas_light_set_texture_offset<class_VisualServer_canvas_light_set_texture_offset>` **(** :ref:`RID<class_rid>` light, :ref:`Vector2<class_vector2>` offset **)** |
  138. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | void | :ref:`canvas_light_set_transform<class_VisualServer_canvas_light_set_transform>` **(** :ref:`RID<class_rid>` light, :ref:`Transform2D<class_transform2d>` transform **)** |
  140. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | void | :ref:`canvas_light_set_z_range<class_VisualServer_canvas_light_set_z_range>` **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)** |
  142. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`RID<class_rid>` | :ref:`canvas_occluder_polygon_create<class_VisualServer_canvas_occluder_polygon_create>` **(** **)** |
  144. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | void | :ref:`canvas_occluder_polygon_set_cull_mode<class_VisualServer_canvas_occluder_polygon_set_cull_mode>` **(** :ref:`RID<class_rid>` occluder_polygon, :ref:`int<class_int>` mode **)** |
  146. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | void | :ref:`canvas_occluder_polygon_set_shape<class_VisualServer_canvas_occluder_polygon_set_shape>` **(** :ref:`RID<class_rid>` occluder_polygon, :ref:`PoolVector2Array<class_poolvector2array>` shape, :ref:`bool<class_bool>` closed **)** |
  148. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | void | :ref:`canvas_occluder_polygon_set_shape_as_lines<class_VisualServer_canvas_occluder_polygon_set_shape_as_lines>` **(** :ref:`RID<class_rid>` occluder_polygon, :ref:`PoolVector2Array<class_poolvector2array>` shape **)** |
  150. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | void | :ref:`canvas_set_item_mirroring<class_VisualServer_canvas_set_item_mirroring>` **(** :ref:`RID<class_rid>` canvas, :ref:`RID<class_rid>` item, :ref:`Vector2<class_vector2>` mirroring **)** |
  152. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | void | :ref:`canvas_set_modulate<class_VisualServer_canvas_set_modulate>` **(** :ref:`RID<class_rid>` canvas, :ref:`Color<class_color>` color **)** |
  154. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | void | :ref:`draw<class_VisualServer_draw>` **(** :ref:`bool<class_bool>` swap_buffers=true **)** |
  156. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | void | :ref:`finish<class_VisualServer_finish>` **(** **)** |
  158. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | void | :ref:`force_draw<class_VisualServer_force_draw>` **(** :ref:`bool<class_bool>` swap_buffers=true **)** |
  160. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | void | :ref:`force_sync<class_VisualServer_force_sync>` **(** **)** |
  162. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | void | :ref:`free<class_VisualServer_free>` **(** :ref:`RID<class_rid>` rid **)** |
  164. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :ref:`int<class_int>` | :ref:`get_render_info<class_VisualServer_get_render_info>` **(** :ref:`int<class_int>` info **)** |
  166. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :ref:`RID<class_rid>` | :ref:`get_test_cube<class_VisualServer_get_test_cube>` **(** **)** |
  168. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | :ref:`RID<class_rid>` | :ref:`get_test_texture<class_VisualServer_get_test_texture>` **(** **)** |
  170. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | :ref:`RID<class_rid>` | :ref:`get_white_texture<class_VisualServer_get_white_texture>` **(** **)** |
  172. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | :ref:`bool<class_bool>` | :ref:`has_changed<class_VisualServer_has_changed>` **(** **)** const |
  174. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | :ref:`bool<class_bool>` | :ref:`has_feature<class_VisualServer_has_feature>` **(** :ref:`int<class_int>` feature **)** const |
  176. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | :ref:`bool<class_bool>` | :ref:`has_os_feature<class_VisualServer_has_os_feature>` **(** :ref:`String<class_string>` feature **)** const |
  178. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | void | :ref:`init<class_VisualServer_init>` **(** **)** |
  180. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | :ref:`RID<class_rid>` | :ref:`make_sphere_mesh<class_VisualServer_make_sphere_mesh>` **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)** |
  182. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | :ref:`RID<class_rid>` | :ref:`material_create<class_VisualServer_material_create>` **(** **)** |
  184. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | :ref:`Variant<class_variant>` | :ref:`material_get_param<class_VisualServer_material_get_param>` **(** :ref:`RID<class_rid>` material, :ref:`String<class_string>` parameter **)** const |
  186. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | :ref:`RID<class_rid>` | :ref:`material_get_shader<class_VisualServer_material_get_shader>` **(** :ref:`RID<class_rid>` shader_material **)** const |
  188. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | void | :ref:`material_set_line_width<class_VisualServer_material_set_line_width>` **(** :ref:`RID<class_rid>` material, :ref:`float<class_float>` width **)** |
  190. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | void | :ref:`material_set_next_pass<class_VisualServer_material_set_next_pass>` **(** :ref:`RID<class_rid>` material, :ref:`RID<class_rid>` next_material **)** |
  192. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | void | :ref:`material_set_param<class_VisualServer_material_set_param>` **(** :ref:`RID<class_rid>` material, :ref:`String<class_string>` parameter, :ref:`Variant<class_variant>` value **)** |
  194. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | void | :ref:`material_set_render_priority<class_VisualServer_material_set_render_priority>` **(** :ref:`RID<class_rid>` material, :ref:`int<class_int>` priority **)** |
  196. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | void | :ref:`material_set_shader<class_VisualServer_material_set_shader>` **(** :ref:`RID<class_rid>` shader_material, :ref:`RID<class_rid>` shader **)** |
  198. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | void | :ref:`mesh_add_surface_from_arrays<class_VisualServer_mesh_add_surface_from_arrays>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` primtive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[ ], :ref:`int<class_int>` compress_format=97792 **)** |
  200. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | void | :ref:`mesh_clear<class_VisualServer_mesh_clear>` **(** :ref:`RID<class_rid>` mesh **)** |
  202. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | :ref:`RID<class_rid>` | :ref:`mesh_create<class_VisualServer_mesh_create>` **(** **)** |
  204. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_count<class_VisualServer_mesh_get_blend_shape_count>` **(** :ref:`RID<class_rid>` mesh **)** const |
  206. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | :ref:`int<class_int>` | :ref:`mesh_get_blend_shape_mode<class_VisualServer_mesh_get_blend_shape_mode>` **(** :ref:`RID<class_rid>` mesh **)** const |
  208. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | :ref:`AABB<class_aabb>` | :ref:`mesh_get_custom_aabb<class_VisualServer_mesh_get_custom_aabb>` **(** :ref:`RID<class_rid>` mesh **)** const |
  210. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | :ref:`int<class_int>` | :ref:`mesh_get_surface_count<class_VisualServer_mesh_get_surface_count>` **(** :ref:`RID<class_rid>` mesh **)** const |
  212. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | void | :ref:`mesh_remove_surface<class_VisualServer_mesh_remove_surface>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` index **)** |
  214. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | void | :ref:`mesh_set_blend_shape_count<class_VisualServer_mesh_set_blend_shape_count>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` amount **)** |
  216. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | void | :ref:`mesh_set_blend_shape_mode<class_VisualServer_mesh_set_blend_shape_mode>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` mode **)** |
  218. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | void | :ref:`mesh_set_custom_aabb<class_VisualServer_mesh_set_custom_aabb>` **(** :ref:`RID<class_rid>` mesh, :ref:`AABB<class_aabb>` aabb **)** |
  220. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | :ref:`AABB<class_aabb>` | :ref:`mesh_surface_get_aabb<class_VisualServer_mesh_surface_get_aabb>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  222. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | :ref:`PoolByteArray<class_poolbytearray>` | :ref:`mesh_surface_get_array<class_VisualServer_mesh_surface_get_array>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  224. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | :ref:`int<class_int>` | :ref:`mesh_surface_get_array_index_len<class_VisualServer_mesh_surface_get_array_index_len>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  226. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | :ref:`int<class_int>` | :ref:`mesh_surface_get_array_len<class_VisualServer_mesh_surface_get_array_len>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  228. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | :ref:`Array<class_array>` | :ref:`mesh_surface_get_arrays<class_VisualServer_mesh_surface_get_arrays>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  230. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | :ref:`Array<class_array>` | :ref:`mesh_surface_get_blend_shape_arrays<class_VisualServer_mesh_surface_get_blend_shape_arrays>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  232. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | :ref:`int<class_int>` | :ref:`mesh_surface_get_format<class_VisualServer_mesh_surface_get_format>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  234. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | :ref:`PoolByteArray<class_poolbytearray>` | :ref:`mesh_surface_get_index_array<class_VisualServer_mesh_surface_get_index_array>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  236. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | :ref:`RID<class_rid>` | :ref:`mesh_surface_get_material<class_VisualServer_mesh_surface_get_material>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  238. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | :ref:`int<class_int>` | :ref:`mesh_surface_get_primitive_type<class_VisualServer_mesh_surface_get_primitive_type>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  240. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | :ref:`Array<class_array>` | :ref:`mesh_surface_get_skeleton_aabb<class_VisualServer_mesh_surface_get_skeleton_aabb>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const |
  242. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | void | :ref:`mesh_surface_set_material<class_VisualServer_mesh_surface_set_material>` **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_rid>` material **)** |
  244. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | void | :ref:`request_frame_drawn_callback<class_VisualServer_request_frame_drawn_callback>` **(** :ref:`Object<class_object>` where, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata **)** |
  246. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | void | :ref:`set_boot_image<class_VisualServer_set_boot_image>` **(** :ref:`Image<class_image>` image, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` scale **)** |
  248. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | void | :ref:`set_debug_generate_wireframes<class_VisualServer_set_debug_generate_wireframes>` **(** :ref:`bool<class_bool>` generate **)** |
  250. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | void | :ref:`set_default_clear_color<class_VisualServer_set_default_clear_color>` **(** :ref:`Color<class_color>` color **)** |
  252. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | :ref:`RID<class_rid>` | :ref:`shader_create<class_VisualServer_shader_create>` **(** **)** |
  254. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | :ref:`String<class_string>` | :ref:`shader_get_code<class_VisualServer_shader_get_code>` **(** :ref:`RID<class_rid>` shader **)** const |
  256. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | :ref:`RID<class_rid>` | :ref:`shader_get_default_texture_param<class_VisualServer_shader_get_default_texture_param>` **(** :ref:`RID<class_rid>` shader, :ref:`String<class_string>` name **)** const |
  258. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | :ref:`Array<class_array>` | :ref:`shader_get_param_list<class_VisualServer_shader_get_param_list>` **(** :ref:`RID<class_rid>` shader **)** const |
  260. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | void | :ref:`shader_set_code<class_VisualServer_shader_set_code>` **(** :ref:`RID<class_rid>` shader, :ref:`String<class_string>` code **)** |
  262. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | void | :ref:`shader_set_default_texture_param<class_VisualServer_shader_set_default_texture_param>` **(** :ref:`RID<class_rid>` shader, :ref:`String<class_string>` name, :ref:`RID<class_rid>` texture **)** |
  264. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | :ref:`RID<class_rid>` | :ref:`sky_create<class_VisualServer_sky_create>` **(** **)** |
  266. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | void | :ref:`sky_set_texture<class_VisualServer_sky_set_texture>` **(** :ref:`RID<class_rid>` sky, :ref:`RID<class_rid>` cube_map, :ref:`int<class_int>` radiance_size **)** |
  268. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | void | :ref:`sync<class_VisualServer_sync>` **(** **)** |
  270. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | void | :ref:`texture_allocate<class_VisualServer_texture_allocate>` **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=7 **)** |
  272. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | :ref:`RID<class_rid>` | :ref:`texture_create<class_VisualServer_texture_create>` **(** **)** |
  274. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`RID<class_rid>` | :ref:`texture_create_from_image<class_VisualServer_texture_create_from_image>` **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)** |
  276. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | :ref:`Array<class_array>` | :ref:`texture_debug_usage<class_VisualServer_texture_debug_usage>` **(** **)** |
  278. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | :ref:`Image<class_image>` | :ref:`texture_get_data<class_VisualServer_texture_get_data>` **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` cube_side=0 **)** const |
  280. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | :ref:`int<class_int>` | :ref:`texture_get_flags<class_VisualServer_texture_get_flags>` **(** :ref:`RID<class_rid>` texture **)** const |
  282. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | :ref:`int<class_int>` | :ref:`texture_get_format<class_VisualServer_texture_get_format>` **(** :ref:`RID<class_rid>` texture **)** const |
  284. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | :ref:`int<class_int>` | :ref:`texture_get_height<class_VisualServer_texture_get_height>` **(** :ref:`RID<class_rid>` texture **)** const |
  286. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`String<class_string>` | :ref:`texture_get_path<class_VisualServer_texture_get_path>` **(** :ref:`RID<class_rid>` texture **)** const |
  288. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | :ref:`int<class_int>` | :ref:`texture_get_texid<class_VisualServer_texture_get_texid>` **(** :ref:`RID<class_rid>` texture **)** const |
  290. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | :ref:`int<class_int>` | :ref:`texture_get_width<class_VisualServer_texture_get_width>` **(** :ref:`RID<class_rid>` texture **)** const |
  292. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | void | :ref:`texture_set_data<class_VisualServer_texture_set_data>` **(** :ref:`RID<class_rid>` texture, :ref:`Image<class_image>` image, :ref:`int<class_int>` cube_side=0 **)** |
  294. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | void | :ref:`texture_set_flags<class_VisualServer_texture_set_flags>` **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` flags **)** |
  296. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | void | :ref:`texture_set_path<class_VisualServer_texture_set_path>` **(** :ref:`RID<class_rid>` texture, :ref:`String<class_string>` path **)** |
  298. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | void | :ref:`texture_set_shrink_all_x2_on_set_data<class_VisualServer_texture_set_shrink_all_x2_on_set_data>` **(** :ref:`bool<class_bool>` shrink **)** |
  300. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | void | :ref:`texture_set_size_override<class_VisualServer_texture_set_size_override>` **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
  302. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | void | :ref:`textures_keep_original<class_VisualServer_textures_keep_original>` **(** :ref:`bool<class_bool>` enable **)** |
  304. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | void | :ref:`viewport_attach_camera<class_VisualServer_viewport_attach_camera>` **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` camera **)** |
  306. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | void | :ref:`viewport_attach_canvas<class_VisualServer_viewport_attach_canvas>` **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas **)** |
  308. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | void | :ref:`viewport_attach_to_screen<class_VisualServer_viewport_attach_to_screen>` **(** :ref:`RID<class_rid>` viewport, :ref:`Rect2<class_rect2>` rect=Rect2( 0, 0, 0, 0 ), :ref:`int<class_int>` screen=0 **)** |
  310. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | :ref:`RID<class_rid>` | :ref:`viewport_create<class_VisualServer_viewport_create>` **(** **)** |
  312. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | void | :ref:`viewport_detach<class_VisualServer_viewport_detach>` **(** :ref:`RID<class_rid>` viewport **)** |
  314. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | :ref:`int<class_int>` | :ref:`viewport_get_render_info<class_VisualServer_viewport_get_render_info>` **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` info **)** |
  316. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | :ref:`RID<class_rid>` | :ref:`viewport_get_texture<class_VisualServer_viewport_get_texture>` **(** :ref:`RID<class_rid>` viewport **)** const |
  318. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | void | :ref:`viewport_remove_canvas<class_VisualServer_viewport_remove_canvas>` **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas **)** |
  320. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | void | :ref:`viewport_set_active<class_VisualServer_viewport_set_active>` **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` active **)** |
  322. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | void | :ref:`viewport_set_canvas_layer<class_VisualServer_viewport_set_canvas_layer>` **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas, :ref:`int<class_int>` layer **)** |
  324. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | void | :ref:`viewport_set_canvas_transform<class_VisualServer_viewport_set_canvas_transform>` **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas, :ref:`Transform2D<class_transform2d>` offset **)** |
  326. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | void | :ref:`viewport_set_clear_mode<class_VisualServer_viewport_set_clear_mode>` **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` clear_mode **)** |
  328. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | void | :ref:`viewport_set_debug_draw<class_VisualServer_viewport_set_debug_draw>` **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` draw **)** |
  330. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | void | :ref:`viewport_set_disable_3d<class_VisualServer_viewport_set_disable_3d>` **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` disabled **)** |
  332. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | void | :ref:`viewport_set_disable_environment<class_VisualServer_viewport_set_disable_environment>` **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` disabled **)** |
  334. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | void | :ref:`viewport_set_global_canvas_transform<class_VisualServer_viewport_set_global_canvas_transform>` **(** :ref:`RID<class_rid>` viewport, :ref:`Transform2D<class_transform2d>` transform **)** |
  336. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | void | :ref:`viewport_set_hdr<class_VisualServer_viewport_set_hdr>` **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` enabled **)** |
  338. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | void | :ref:`viewport_set_hide_canvas<class_VisualServer_viewport_set_hide_canvas>` **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` hidden **)** |
  340. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | void | :ref:`viewport_set_hide_scenario<class_VisualServer_viewport_set_hide_scenario>` **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` hidden **)** |
  342. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | void | :ref:`viewport_set_msaa<class_VisualServer_viewport_set_msaa>` **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` msaa **)** |
  344. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | void | :ref:`viewport_set_parent_viewport<class_VisualServer_viewport_set_parent_viewport>` **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` parent_viewport **)** |
  346. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | void | :ref:`viewport_set_scenario<class_VisualServer_viewport_set_scenario>` **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` scenario **)** |
  348. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | void | :ref:`viewport_set_shadow_atlas_quadrant_subdivision<class_VisualServer_viewport_set_shadow_atlas_quadrant_subdivision>` **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)** |
  350. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | void | :ref:`viewport_set_shadow_atlas_size<class_VisualServer_viewport_set_shadow_atlas_size>` **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` size **)** |
  352. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | void | :ref:`viewport_set_size<class_VisualServer_viewport_set_size>` **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)** |
  354. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | void | :ref:`viewport_set_transparent_background<class_VisualServer_viewport_set_transparent_background>` **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` enabled **)** |
  356. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | void | :ref:`viewport_set_update_mode<class_VisualServer_viewport_set_update_mode>` **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` update_mode **)** |
  358. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | void | :ref:`viewport_set_usage<class_VisualServer_viewport_set_usage>` **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` usage **)** |
  360. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | void | :ref:`viewport_set_use_arvr<class_VisualServer_viewport_set_use_arvr>` **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` use_arvr **)** |
  362. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | void | :ref:`viewport_set_vflip<class_VisualServer_viewport_set_vflip>` **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` enabled **)** |
  364. +--------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. Signals
  366. -------
  367. .. _class_VisualServer_frame_drawn_in_thread:
  368. - **frame_drawn_in_thread** **(** **)**
  369. Numeric Constants
  370. -----------------
  371. - **NO_INDEX_ARRAY** = **-1** --- Marks an error that shows that the index array is empty.
  372. - **ARRAY_WEIGHTS_SIZE** = **4**
  373. - **CANVAS_ITEM_Z_MIN** = **-4096** --- The minimum Z-layer for canvas items.
  374. - **CANVAS_ITEM_Z_MAX** = **4096** --- The maximum Z-layer for canvas items.
  375. - **MAX_GLOW_LEVELS** = **7**
  376. - **MAX_CURSORS** = **8**
  377. - **MATERIAL_RENDER_PRIORITY_MIN** = **-128** --- The minimum renderpriority of all materials.
  378. - **MATERIAL_RENDER_PRIORITY_MAX** = **127** --- The maximum renderpriority of all materials.
  379. - **CUBEMAP_LEFT** = **0** --- Marks the left side of a cubemap.
  380. - **CUBEMAP_RIGHT** = **1** --- Marks the right side of a cubemap.
  381. - **CUBEMAP_BOTTOM** = **2** --- Marks the bottom side of a cubemap.
  382. - **CUBEMAP_TOP** = **3** --- Marks the top side of a cubemap.
  383. - **CUBEMAP_FRONT** = **4** --- Marks the front side of a cubemap.
  384. - **CUBEMAP_BACK** = **5** --- Marks the back side of a cubemap.
  385. - **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
  386. - **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge).
  387. - **TEXTURE_FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture.
  388. - **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** --- Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
  389. More effective on planes often shown going to the horrizon as those textures (Walls or Ground for example) get squashed in the viewport to different aspect ratios and regular mipmaps keep the aspect ratio so they don't optimize storage that well in those cases.
  390. - **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space.
  391. - **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeat texture with alternate sections mirrored.
  392. - **TEXTURE_FLAG_CUBEMAP** = **2048** --- Texture is a cubemap.
  393. - **TEXTURE_FLAG_USED_FOR_STREAMING** = **4096** --- Texture is a video surface.
  394. - **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.
  395. - **SHADER_SPATIAL** = **0** --- Shader is a 3D shader.
  396. - **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader.
  397. - **SHADER_PARTICLES** = **2** --- Shader is a particle shader.
  398. - **SHADER_MAX** = **3** --- Marks maximum of the shader types array. used internally.
  399. - **ARRAY_VERTEX** = **0** --- Array is a vertex array.
  400. - **ARRAY_NORMAL** = **1** --- Array is a normal array.
  401. - **ARRAY_TANGENT** = **2** --- Array is a tangent array.
  402. - **ARRAY_COLOR** = **3** --- Array is a color array.
  403. - **ARRAY_TEX_UV** = **4** --- Array is a uv coordinates array.
  404. - **ARRAY_TEX_UV2** = **5** --- Array is a uv coordinates array for the second uv coordinates.
  405. - **ARRAY_BONES** = **6** --- Array contains bone information.
  406. - **ARRAY_WEIGHTS** = **7** --- Array is weight information.
  407. - **ARRAY_INDEX** = **8** --- Array is index array.
  408. - **ARRAY_MAX** = **9** --- Marks the maximum of the array types. Used internally.
  409. - **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array.
  410. - **ARRAY_FORMAT_NORMAL** = **2** --- Flag used to mark a normal array.
  411. - **ARRAY_FORMAT_TANGENT** = **4** --- Flag used to mark a tangent array.
  412. - **ARRAY_FORMAT_COLOR** = **8** --- Flag used to mark a color array.
  413. - **ARRAY_FORMAT_TEX_UV** = **16** --- Flag used to mark a uv coordinates array.
  414. - **ARRAY_FORMAT_TEX_UV2** = **32** --- Flag used to mark a uv coordinates array for the second uv coordinates.
  415. - **ARRAY_FORMAT_BONES** = **64** --- Flag used to mark a bone information array.
  416. - **ARRAY_FORMAT_WEIGHTS** = **128** --- Flag used to mark a weights array.
  417. - **ARRAY_FORMAT_INDEX** = **256** --- Flag used to mark a index array.
  418. - **ARRAY_COMPRESS_VERTEX** = **512** --- Flag used to mark a compressed (half float) vertex array.
  419. - **ARRAY_COMPRESS_NORMAL** = **1024** --- Flag used to mark a compressed (half float) normal array.
  420. - **ARRAY_COMPRESS_TANGENT** = **2048** --- Flag used to mark a compressed (half float) tangent array.
  421. - **ARRAY_COMPRESS_COLOR** = **4096** --- Flag used to mark a compressed (half float) color array.
  422. - **ARRAY_COMPRESS_TEX_UV** = **8192** --- Flag used to mark a compressed (half float) uv coordinates array.
  423. - **ARRAY_COMPRESS_TEX_UV2** = **16384** --- Flag used to mark a compressed (half float) uv coordinates array for the second uv coordinates.
  424. - **ARRAY_COMPRESS_BONES** = **32768**
  425. - **ARRAY_COMPRESS_WEIGHTS** = **65536** --- Flag used to mark a compressed (half float) weight array.
  426. - **ARRAY_COMPRESS_INDEX** = **131072**
  427. - **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices.
  428. - **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16 bit bones instead of 8 bit.
  429. - **ARRAY_COMPRESS_DEFAULT** = **97792** --- Used to set flags ARRAY_COMPRESS_VERTEX, ARRAY_COMPRESS_NORMAL, ARRAY_COMPRESS_TANGENT, ARRAY_COMPRESS_COLOR, ARRAY_COMPRESS_TEX_UV, ARRAY_COMPRESS_TEX_UV2 and ARRAY_COMPRESS_WEIGHTS quickly.
  430. - **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points.
  431. - **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines.
  432. - **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end.
  433. - **PRIMITIVE_LINE_LOOP** = **3** --- Primitive to draw consists of a line loop (a line strip with a line between the last and the first vertex).
  434. - **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles.
  435. - **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 verticies are always combined to make a triangle).
  436. - **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 verticies are always combined with the first to make a triangle).
  437. - **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally.
  438. - **BLEND_SHAPE_MODE_NORMALIZED** = **0**
  439. - **BLEND_SHAPE_MODE_RELATIVE** = **1**
  440. - **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light.
  441. - **LIGHT_OMNI** = **1** --- is an omni light.
  442. - **LIGHT_SPOT** = **2** --- is an spot light.
  443. - **LIGHT_PARAM_ENERGY** = **0** --- The light's energy.
  444. - **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity.
  445. - **LIGHT_PARAM_RANGE** = **3** --- The light's range.
  446. - **LIGHT_PARAM_ATTENUATION** = **4** --- The light's attenuation.
  447. - **LIGHT_PARAM_SPOT_ANGLE** = **5** --- The spotlight's angle.
  448. - **LIGHT_PARAM_SPOT_ATTENUATION** = **6** --- The spotlight's attenuation.
  449. - **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **7** --- Scales the shadow color.
  450. - **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **8**
  451. - **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **9**
  452. - **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **10**
  453. - **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **11**
  454. - **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **12**
  455. - **LIGHT_PARAM_SHADOW_BIAS** = **13**
  456. - **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14**
  457. - **LIGHT_PARAM_MAX** = **15** --- The light parameters endpoint. Used internally.
  458. - **VIEWPORT_UPDATE_DISABLED** = **0**
  459. - **VIEWPORT_UPDATE_ONCE** = **1**
  460. - **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2**
  461. - **VIEWPORT_UPDATE_ALWAYS** = **3**
  462. - **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing.
  463. - **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing.
  464. - **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER.
  465. - **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled.
  466. - **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X.
  467. - **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4X.
  468. - **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X.
  469. - **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X.
  470. - **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples.
  471. - **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample.
  472. - **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects.
  473. - **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects.
  474. - **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0**
  475. - **VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME** = **1**
  476. - **VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2**
  477. - **VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3**
  478. - **VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4**
  479. - **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5**
  480. - **VIEWPORT_RENDER_INFO_MAX** = **6** --- Marks end of VIEWPORT_RENDER_INFO\* constants. Used internally.
  481. - **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting.
  482. - **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded.
  483. - **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``.
  484. - **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe.
  485. - **SCENARIO_DEBUG_DISABLED** = **0**
  486. - **SCENARIO_DEBUG_WIREFRAME** = **1**
  487. - **SCENARIO_DEBUG_OVERDRAW** = **2**
  488. - **SCENARIO_DEBUG_SHADELESS** = **3**
  489. - **INSTANCE_NONE** = **0** --- The instance does not have a type.
  490. - **INSTANCE_MESH** = **1** --- The instance is a mesh.
  491. - **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh.
  492. - **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry.
  493. - **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter.
  494. - **INSTANCE_LIGHT** = **5** --- The instance is a light.
  495. - **INSTANCE_REFLECTION_PROBE** = **6**
  496. - **INSTANCE_GI_PROBE** = **7**
  497. - **INSTANCE_LIGHTMAP_CAPTURE** = **8**
  498. - **INSTANCE_MAX** = **9** --- The max value for INSTANCE\_\* constants, used internally.
  499. - **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
  500. - **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed.
  501. - **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed.
  502. - **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed.
  503. - **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas.
  504. - **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas.
  505. - **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency.
  506. - **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask.
  507. - **CANVAS_LIGHT_FILTER_NONE** = **0**
  508. - **CANVAS_LIGHT_FILTER_PCF3** = **1**
  509. - **CANVAS_LIGHT_FILTER_PCF5** = **2**
  510. - **CANVAS_LIGHT_FILTER_PCF7** = **3**
  511. - **CANVAS_LIGHT_FILTER_PCF9** = **4**
  512. - **CANVAS_LIGHT_FILTER_PCF13** = **5**
  513. - **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled.
  514. - **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise.
  515. - **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise.
  516. - **INFO_OBJECTS_IN_FRAME** = **0** --- The amount of objects in the frame.
  517. - **INFO_VERTICES_IN_FRAME** = **1** --- The amount of vertices in the frame.
  518. - **INFO_MATERIAL_CHANGES_IN_FRAME** = **2** --- The amount of modified materials in the frame.
  519. - **INFO_SHADER_CHANGES_IN_FRAME** = **3** --- The amount of shader rebinds in the frame.
  520. - **INFO_SURFACE_CHANGES_IN_FRAME** = **4** --- The amount of surface changes in the frame.
  521. - **INFO_DRAW_CALLS_IN_FRAME** = **5** --- The amount of draw calls in frame.
  522. - **INFO_USAGE_VIDEO_MEM_TOTAL** = **6**
  523. - **INFO_VIDEO_MEM_USED** = **7** --- The amount of vertex memory and texture memory used.
  524. - **INFO_TEXTURE_MEM_USED** = **8** --- The amount of texture memory used.
  525. - **INFO_VERTEX_MEM_USED** = **9** --- The amount of vertex memory used.
  526. - **FEATURE_SHADERS** = **0**
  527. - **FEATURE_MULTITHREADED** = **1**
  528. Description
  529. -----------
  530. Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display.
  531. The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
  532. Member Function Description
  533. ---------------------------
  534. .. _class_VisualServer_black_bars_set_images:
  535. - void **black_bars_set_images** **(** :ref:`RID<class_rid>` left, :ref:`RID<class_rid>` top, :ref:`RID<class_rid>` right, :ref:`RID<class_rid>` bottom **)**
  536. Sets images to be rendered in the window margin.
  537. .. _class_VisualServer_black_bars_set_margins:
  538. - void **black_bars_set_margins** **(** :ref:`int<class_int>` left, :ref:`int<class_int>` top, :ref:`int<class_int>` right, :ref:`int<class_int>` bottom **)**
  539. Sets margin size, where black bars (or images, if :ref:`black_bars_set_images<class_VisualServer_black_bars_set_images>` was used) are rendered.
  540. .. _class_VisualServer_canvas_create:
  541. - :ref:`RID<class_rid>` **canvas_create** **(** **)**
  542. Creates a canvas and returns the assigned :ref:`RID<class_rid>`.
  543. .. _class_VisualServer_canvas_item_add_circle:
  544. - void **canvas_item_add_circle** **(** :ref:`RID<class_rid>` item, :ref:`Vector2<class_vector2>` pos, :ref:`float<class_float>` radius, :ref:`Color<class_color>` color **)**
  545. Adds a circle command to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  546. .. _class_VisualServer_canvas_item_add_clip_ignore:
  547. - void **canvas_item_add_clip_ignore** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` ignore **)**
  548. If ignore is ``true``, the VisualServer does not perform clipping.
  549. .. _class_VisualServer_canvas_item_add_line:
  550. - void **canvas_item_add_line** **(** :ref:`RID<class_rid>` item, :ref:`Vector2<class_vector2>` from, :ref:`Vector2<class_vector2>` to, :ref:`Color<class_color>` color, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
  551. Adds a line command to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  552. .. _class_VisualServer_canvas_item_add_mesh:
  553. - void **canvas_item_add_mesh** **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` mesh, :ref:`RID<class_rid>` skeleton **)**
  554. Adds a :ref:`Mesh<class_mesh>` to the :ref:`CanvasItem<class_canvasitem>`'s draw commands. Only affects its aabb at the moment.
  555. .. _class_VisualServer_canvas_item_add_multimesh:
  556. - void **canvas_item_add_multimesh** **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` mesh, :ref:`RID<class_rid>` skeleton **)**
  557. Adds a :ref:`MultiMesh<class_multimesh>` to the :ref:`CanvasItem<class_canvasitem>`'s draw commands. Only affects its aabb at the moment.
  558. .. _class_VisualServer_canvas_item_add_nine_patch:
  559. - void **canvas_item_add_nine_patch** **(** :ref:`RID<class_rid>` item, :ref:`Rect2<class_rect2>` rect, :ref:`Rect2<class_rect2>` source, :ref:`RID<class_rid>` texture, :ref:`Vector2<class_vector2>` topleft, :ref:`Vector2<class_vector2>` bottomright, :ref:`int<class_int>` x_axis_mode=0, :ref:`int<class_int>` y_axis_mode=0, :ref:`bool<class_bool>` draw_center=true, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`RID<class_rid>` normal_map **)**
  560. Adds a nine patch image to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  561. See :ref:`NinePatchRect<class_ninepatchrect>` for more explanation.
  562. .. _class_VisualServer_canvas_item_add_particles:
  563. - void **canvas_item_add_particles** **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` particles, :ref:`RID<class_rid>` texture, :ref:`RID<class_rid>` normal_map, :ref:`int<class_int>` h_frames, :ref:`int<class_int>` v_frames **)**
  564. Adds a particles system to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  565. .. _class_VisualServer_canvas_item_add_polygon:
  566. - void **canvas_item_add_polygon** **(** :ref:`RID<class_rid>` item, :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs=PoolVector2Array( ), :ref:`RID<class_rid>` texture, :ref:`RID<class_rid>` normal_map, :ref:`bool<class_bool>` antialiased=false **)**
  567. Adds a polygon to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  568. .. _class_VisualServer_canvas_item_add_polyline:
  569. - void **canvas_item_add_polyline** **(** :ref:`RID<class_rid>` item, :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`float<class_float>` width=1.0, :ref:`bool<class_bool>` antialiased=false **)**
  570. Adds a polyline, which is a line from mutliple points with a width, to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  571. .. _class_VisualServer_canvas_item_add_primitive:
  572. - void **canvas_item_add_primitive** **(** :ref:`RID<class_rid>` item, :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs, :ref:`RID<class_rid>` texture, :ref:`float<class_float>` width=1.0, :ref:`RID<class_rid>` normal_map **)**
  573. Adds a primitive to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  574. .. _class_VisualServer_canvas_item_add_rect:
  575. - void **canvas_item_add_rect** **(** :ref:`RID<class_rid>` item, :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color **)**
  576. Adds a rectangle to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  577. .. _class_VisualServer_canvas_item_add_set_transform:
  578. - void **canvas_item_add_set_transform** **(** :ref:`RID<class_rid>` item, :ref:`Transform2D<class_transform2d>` transform **)**
  579. Adds a :ref:`Transform2D<class_transform2d>` command to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  580. This sets the extra_matrix uniform when executed. This affects the later command's of the canvas item.
  581. .. _class_VisualServer_canvas_item_add_texture_rect:
  582. - void **canvas_item_add_texture_rect** **(** :ref:`RID<class_rid>` item, :ref:`Rect2<class_rect2>` rect, :ref:`RID<class_rid>` texture, :ref:`bool<class_bool>` tile=false, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`RID<class_rid>` normal_map **)**
  583. Adds a textured rect to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  584. .. _class_VisualServer_canvas_item_add_texture_rect_region:
  585. - void **canvas_item_add_texture_rect_region** **(** :ref:`RID<class_rid>` item, :ref:`Rect2<class_rect2>` rect, :ref:`RID<class_rid>` texture, :ref:`Rect2<class_rect2>` src_rect, :ref:`Color<class_color>` modulate=Color( 1, 1, 1, 1 ), :ref:`bool<class_bool>` transpose=false, :ref:`RID<class_rid>` normal_map, :ref:`bool<class_bool>` clip_uv=true **)**
  586. Adds a texture rect with region setting to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  587. .. _class_VisualServer_canvas_item_add_triangle_array:
  588. - void **canvas_item_add_triangle_array** **(** :ref:`RID<class_rid>` item, :ref:`PoolIntArray<class_poolintarray>` indices, :ref:`PoolVector2Array<class_poolvector2array>` points, :ref:`PoolColorArray<class_poolcolorarray>` colors, :ref:`PoolVector2Array<class_poolvector2array>` uvs=PoolVector2Array( ), :ref:`RID<class_rid>` texture, :ref:`int<class_int>` count=-1, :ref:`RID<class_rid>` normal_map **)**
  589. Adds a triangle array to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  590. .. _class_VisualServer_canvas_item_clear:
  591. - void **canvas_item_clear** **(** :ref:`RID<class_rid>` item **)**
  592. Clears the :ref:`CanvasItem<class_canvasitem>` and removes all commands in it.
  593. .. _class_VisualServer_canvas_item_create:
  594. - :ref:`RID<class_rid>` **canvas_item_create** **(** **)**
  595. Creates a new :ref:`CanvasItem<class_canvasitem>` and returns its :ref:`RID<class_rid>`.
  596. .. _class_VisualServer_canvas_item_set_clip:
  597. - void **canvas_item_set_clip** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` clip **)**
  598. Sets clipping for the :ref:`CanvasItem<class_canvasitem>`.
  599. .. _class_VisualServer_canvas_item_set_copy_to_backbuffer:
  600. - void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_rect2>` rect **)**
  601. Sets the :ref:`CanvasItem<class_canvasitem>` to copy a rect to the backbuffer.
  602. .. _class_VisualServer_canvas_item_set_custom_rect:
  603. - void **canvas_item_set_custom_rect** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` use_custom_rect, :ref:`Rect2<class_rect2>` rect=Rect2( 0, 0, 0, 0 ) **)**
  604. Defines a custom drawing rectangle for the :ref:`CanvasItem<class_canvasitem>`.
  605. .. _class_VisualServer_canvas_item_set_distance_field_mode:
  606. - void **canvas_item_set_distance_field_mode** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  607. .. _class_VisualServer_canvas_item_set_draw_behind_parent:
  608. - void **canvas_item_set_draw_behind_parent** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  609. Sets :ref:`CanvasItem<class_canvasitem>` to be drawn behind its parent.
  610. .. _class_VisualServer_canvas_item_set_draw_index:
  611. - void **canvas_item_set_draw_index** **(** :ref:`RID<class_rid>` item, :ref:`int<class_int>` index **)**
  612. Sets the index for the :ref:`CanvasItem<class_canvasitem>`.
  613. .. _class_VisualServer_canvas_item_set_light_mask:
  614. - void **canvas_item_set_light_mask** **(** :ref:`RID<class_rid>` item, :ref:`int<class_int>` mask **)**
  615. The light mask. See :ref:`LightOccluder2D<class_lightoccluder2d>` for more information on light masks.
  616. .. _class_VisualServer_canvas_item_set_material:
  617. - void **canvas_item_set_material** **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` material **)**
  618. Sets a new material to the :ref:`CanvasItem<class_canvasitem>`.
  619. .. _class_VisualServer_canvas_item_set_modulate:
  620. - void **canvas_item_set_modulate** **(** :ref:`RID<class_rid>` item, :ref:`Color<class_color>` color **)**
  621. Sets the color that modulates the :ref:`CanvasItem<class_canvasitem>` and its children.
  622. .. _class_VisualServer_canvas_item_set_parent:
  623. - void **canvas_item_set_parent** **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` parent **)**
  624. Sets the parent for the :ref:`CanvasItem<class_canvasitem>`.
  625. .. _class_VisualServer_canvas_item_set_self_modulate:
  626. - void **canvas_item_set_self_modulate** **(** :ref:`RID<class_rid>` item, :ref:`Color<class_color>` color **)**
  627. Sets the color that modulates the :ref:`CanvasItem<class_canvasitem>` without children.
  628. .. _class_VisualServer_canvas_item_set_sort_children_by_y:
  629. - void **canvas_item_set_sort_children_by_y** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  630. Sets if :ref:`CanvasItem<class_canvasitem>`'s children should be sorted by y-position.
  631. .. _class_VisualServer_canvas_item_set_transform:
  632. - void **canvas_item_set_transform** **(** :ref:`RID<class_rid>` item, :ref:`Transform2D<class_transform2d>` transform **)**
  633. Sets the :ref:`CanvasItem<class_canvasitem>`'s :ref:`Transform2D<class_transform2d>`.
  634. .. _class_VisualServer_canvas_item_set_use_parent_material:
  635. - void **canvas_item_set_use_parent_material** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  636. Sets if the :ref:`CanvasItem<class_canvasitem>` uses its parent's material.
  637. .. _class_VisualServer_canvas_item_set_visible:
  638. - void **canvas_item_set_visible** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` visible **)**
  639. Sets if the canvas item (including its children) is visible.
  640. .. _class_VisualServer_canvas_item_set_z_as_relative_to_parent:
  641. - void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  642. If this is enabled, the z-index of the parent will be added to the children's z-index.
  643. .. _class_VisualServer_canvas_item_set_z_index:
  644. - void **canvas_item_set_z_index** **(** :ref:`RID<class_rid>` item, :ref:`int<class_int>` z_index **)**
  645. Sets the :ref:`CanvasItem<class_canvasitem>`'s z-index, i.e. its draw order (lower indexes are drawn first).
  646. .. _class_VisualServer_canvas_light_attach_to_canvas:
  647. - void **canvas_light_attach_to_canvas** **(** :ref:`RID<class_rid>` light, :ref:`RID<class_rid>` canvas **)**
  648. Attaches the canvas light to the canvas. Removes it from its previous canvas.
  649. .. _class_VisualServer_canvas_light_create:
  650. - :ref:`RID<class_rid>` **canvas_light_create** **(** **)**
  651. Creates a canvas light.
  652. .. _class_VisualServer_canvas_light_occluder_attach_to_canvas:
  653. - void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID<class_rid>` occluder, :ref:`RID<class_rid>` canvas **)**
  654. Attaches a light occluder to the canvas. Removes it from its previous canvas.
  655. .. _class_VisualServer_canvas_light_occluder_create:
  656. - :ref:`RID<class_rid>` **canvas_light_occluder_create** **(** **)**
  657. Creates a light occluder.
  658. .. _class_VisualServer_canvas_light_occluder_set_enabled:
  659. - void **canvas_light_occluder_set_enabled** **(** :ref:`RID<class_rid>` occluder, :ref:`bool<class_bool>` enabled **)**
  660. Enables or disables light occluder.
  661. .. _class_VisualServer_canvas_light_occluder_set_light_mask:
  662. - void **canvas_light_occluder_set_light_mask** **(** :ref:`RID<class_rid>` occluder, :ref:`int<class_int>` mask **)**
  663. The light mask. See :ref:`LightOccluder2D<class_lightoccluder2d>` for more information on light masks
  664. .. _class_VisualServer_canvas_light_occluder_set_polygon:
  665. - void **canvas_light_occluder_set_polygon** **(** :ref:`RID<class_rid>` occluder, :ref:`RID<class_rid>` polygon **)**
  666. Sets a light occluder's polygon.
  667. .. _class_VisualServer_canvas_light_occluder_set_transform:
  668. - void **canvas_light_occluder_set_transform** **(** :ref:`RID<class_rid>` occluder, :ref:`Transform2D<class_transform2d>` transform **)**
  669. Sets a light occluder's :ref:`Transform2D<class_transform2d>`.
  670. .. _class_VisualServer_canvas_light_set_color:
  671. - void **canvas_light_set_color** **(** :ref:`RID<class_rid>` light, :ref:`Color<class_color>` color **)**
  672. Sets the color for a light.
  673. .. _class_VisualServer_canvas_light_set_enabled:
  674. - void **canvas_light_set_enabled** **(** :ref:`RID<class_rid>` light, :ref:`bool<class_bool>` enabled **)**
  675. Enables or disables a canvas light.
  676. .. _class_VisualServer_canvas_light_set_energy:
  677. - void **canvas_light_set_energy** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` energy **)**
  678. Sets a canvas light's energy.
  679. .. _class_VisualServer_canvas_light_set_height:
  680. - void **canvas_light_set_height** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` height **)**
  681. Sets a canvas light's height.
  682. .. _class_VisualServer_canvas_light_set_item_cull_mask:
  683. - void **canvas_light_set_item_cull_mask** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` mask **)**
  684. The light mask. See :ref:`LightOccluder2D<class_lightoccluder2d>` for more information on light masks
  685. .. _class_VisualServer_canvas_light_set_item_shadow_cull_mask:
  686. - void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` mask **)**
  687. The shadow mask. binary about wich layers this canvas light affects wich canvas item's shadows. See :ref:`LightOccluder2D<class_lightoccluder2d>` for more information on light masks.
  688. .. _class_VisualServer_canvas_light_set_layer_range:
  689. - void **canvas_light_set_layer_range** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)**
  690. The layer range that gets rendered with this light.
  691. .. _class_VisualServer_canvas_light_set_mode:
  692. - void **canvas_light_set_mode** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` mode **)**
  693. The mode of the light, see CANVAS_LIGHT_MODE\_\* constants.
  694. .. _class_VisualServer_canvas_light_set_scale:
  695. - void **canvas_light_set_scale** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` scale **)**
  696. .. _class_VisualServer_canvas_light_set_shadow_buffer_size:
  697. - void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` size **)**
  698. Sets the width of the shadow buffer, size gets scaled to the next power of two for this.
  699. .. _class_VisualServer_canvas_light_set_shadow_color:
  700. - void **canvas_light_set_shadow_color** **(** :ref:`RID<class_rid>` light, :ref:`Color<class_color>` color **)**
  701. Sets the color of the canvas light's shadow.
  702. .. _class_VisualServer_canvas_light_set_shadow_enabled:
  703. - void **canvas_light_set_shadow_enabled** **(** :ref:`RID<class_rid>` light, :ref:`bool<class_bool>` enabled **)**
  704. Enables or disables the canvas light's shadow.
  705. .. _class_VisualServer_canvas_light_set_shadow_filter:
  706. - void **canvas_light_set_shadow_filter** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` filter **)**
  707. Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER\_\* constants.
  708. .. _class_VisualServer_canvas_light_set_shadow_gradient_length:
  709. - void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` length **)**
  710. Sets the length of the shadow's gradient.
  711. .. _class_VisualServer_canvas_light_set_shadow_smooth:
  712. - void **canvas_light_set_shadow_smooth** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` smooth **)**
  713. Smoothens the shadow. The lower, the more smooth.
  714. .. _class_VisualServer_canvas_light_set_texture:
  715. - void **canvas_light_set_texture** **(** :ref:`RID<class_rid>` light, :ref:`RID<class_rid>` texture **)**
  716. .. _class_VisualServer_canvas_light_set_texture_offset:
  717. - void **canvas_light_set_texture_offset** **(** :ref:`RID<class_rid>` light, :ref:`Vector2<class_vector2>` offset **)**
  718. .. _class_VisualServer_canvas_light_set_transform:
  719. - void **canvas_light_set_transform** **(** :ref:`RID<class_rid>` light, :ref:`Transform2D<class_transform2d>` transform **)**
  720. Sets the canvas light's :ref:`Transform2D<class_transform2d>`.
  721. .. _class_VisualServer_canvas_light_set_z_range:
  722. - void **canvas_light_set_z_range** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)**
  723. .. _class_VisualServer_canvas_occluder_polygon_create:
  724. - :ref:`RID<class_rid>` **canvas_occluder_polygon_create** **(** **)**
  725. Creates a new light occluder polygon.
  726. .. _class_VisualServer_canvas_occluder_polygon_set_cull_mode:
  727. - void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID<class_rid>` occluder_polygon, :ref:`int<class_int>` mode **)**
  728. Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE\_\* constants.
  729. .. _class_VisualServer_canvas_occluder_polygon_set_shape:
  730. - void **canvas_occluder_polygon_set_shape** **(** :ref:`RID<class_rid>` occluder_polygon, :ref:`PoolVector2Array<class_poolvector2array>` shape, :ref:`bool<class_bool>` closed **)**
  731. Sets the shape of the occluder polygon.
  732. .. _class_VisualServer_canvas_occluder_polygon_set_shape_as_lines:
  733. - void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID<class_rid>` occluder_polygon, :ref:`PoolVector2Array<class_poolvector2array>` shape **)**
  734. Sets the shape of the occluder polygon as lines.
  735. .. _class_VisualServer_canvas_set_item_mirroring:
  736. - void **canvas_set_item_mirroring** **(** :ref:`RID<class_rid>` canvas, :ref:`RID<class_rid>` item, :ref:`Vector2<class_vector2>` mirroring **)**
  737. A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2<class_vector2>`.
  738. .. _class_VisualServer_canvas_set_modulate:
  739. - void **canvas_set_modulate** **(** :ref:`RID<class_rid>` canvas, :ref:`Color<class_color>` color **)**
  740. Modulates all colors in the given canvas.
  741. .. _class_VisualServer_draw:
  742. - void **draw** **(** :ref:`bool<class_bool>` swap_buffers=true **)**
  743. Draws a frame.
  744. .. _class_VisualServer_finish:
  745. - void **finish** **(** **)**
  746. Removes buffers and clears testcubes.
  747. .. _class_VisualServer_force_draw:
  748. - void **force_draw** **(** :ref:`bool<class_bool>` swap_buffers=true **)**
  749. Draws a frame. Same as :ref:`draw<class_VisualServer_draw>`.
  750. .. _class_VisualServer_force_sync:
  751. - void **force_sync** **(** **)**
  752. Syncronizes threads.
  753. .. _class_VisualServer_free:
  754. - void **free** **(** :ref:`RID<class_rid>` rid **)**
  755. Tries to free an object in the VisualServer.
  756. .. _class_VisualServer_get_render_info:
  757. - :ref:`int<class_int>` **get_render_info** **(** :ref:`int<class_int>` info **)**
  758. Returns a certain information, see RENDER_INFO\_\* for options.
  759. .. _class_VisualServer_get_test_cube:
  760. - :ref:`RID<class_rid>` **get_test_cube** **(** **)**
  761. Returns the id of the test cube. Creates one if none exists.
  762. .. _class_VisualServer_get_test_texture:
  763. - :ref:`RID<class_rid>` **get_test_texture** **(** **)**
  764. Returns the id of the test texture. Creates one if none exists.
  765. .. _class_VisualServer_get_white_texture:
  766. - :ref:`RID<class_rid>` **get_white_texture** **(** **)**
  767. Returns the id of a white texture. Creates one if none exists.
  768. .. _class_VisualServer_has_changed:
  769. - :ref:`bool<class_bool>` **has_changed** **(** **)** const
  770. Returns ``true`` if changes have been made to the VisualServer's data. :ref:`draw<class_VisualServer_draw>` is usually called if this happens.
  771. .. _class_VisualServer_has_feature:
  772. - :ref:`bool<class_bool>` **has_feature** **(** :ref:`int<class_int>` feature **)** const
  773. .. _class_VisualServer_has_os_feature:
  774. - :ref:`bool<class_bool>` **has_os_feature** **(** :ref:`String<class_string>` feature **)** const
  775. Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc,
  776. .. _class_VisualServer_init:
  777. - void **init** **(** **)**
  778. Initializes the visual server.
  779. .. _class_VisualServer_make_sphere_mesh:
  780. - :ref:`RID<class_rid>` **make_sphere_mesh** **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)**
  781. Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
  782. .. _class_VisualServer_material_create:
  783. - :ref:`RID<class_rid>` **material_create** **(** **)**
  784. Returns an empty material.
  785. .. _class_VisualServer_material_get_param:
  786. - :ref:`Variant<class_variant>` **material_get_param** **(** :ref:`RID<class_rid>` material, :ref:`String<class_string>` parameter **)** const
  787. Returns the value of a certain material's parameter.
  788. .. _class_VisualServer_material_get_shader:
  789. - :ref:`RID<class_rid>` **material_get_shader** **(** :ref:`RID<class_rid>` shader_material **)** const
  790. Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader.
  791. .. _class_VisualServer_material_set_line_width:
  792. - void **material_set_line_width** **(** :ref:`RID<class_rid>` material, :ref:`float<class_float>` width **)**
  793. Sets a materials line width.
  794. .. _class_VisualServer_material_set_next_pass:
  795. - void **material_set_next_pass** **(** :ref:`RID<class_rid>` material, :ref:`RID<class_rid>` next_material **)**
  796. Sets an objects next material.
  797. .. _class_VisualServer_material_set_param:
  798. - void **material_set_param** **(** :ref:`RID<class_rid>` material, :ref:`String<class_string>` parameter, :ref:`Variant<class_variant>` value **)**
  799. Sets a materials parameter.
  800. .. _class_VisualServer_material_set_render_priority:
  801. - void **material_set_render_priority** **(** :ref:`RID<class_rid>` material, :ref:`int<class_int>` priority **)**
  802. Sets a material's render priority.
  803. .. _class_VisualServer_material_set_shader:
  804. - void **material_set_shader** **(** :ref:`RID<class_rid>` shader_material, :ref:`RID<class_rid>` shader **)**
  805. Sets a shader material's shader.
  806. .. _class_VisualServer_mesh_add_surface_from_arrays:
  807. - void **mesh_add_surface_from_arrays** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` primtive, :ref:`Array<class_array>` arrays, :ref:`Array<class_array>` blend_shapes=[ ], :ref:`int<class_int>` compress_format=97792 **)**
  808. Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE\_\* constants for types.
  809. .. _class_VisualServer_mesh_clear:
  810. - void **mesh_clear** **(** :ref:`RID<class_rid>` mesh **)**
  811. Removes all surfaces from a mesh.
  812. .. _class_VisualServer_mesh_create:
  813. - :ref:`RID<class_rid>` **mesh_create** **(** **)**
  814. Creates a new mesh.
  815. .. _class_VisualServer_mesh_get_blend_shape_count:
  816. - :ref:`int<class_int>` **mesh_get_blend_shape_count** **(** :ref:`RID<class_rid>` mesh **)** const
  817. Returns a mesh's blend shape count.
  818. .. _class_VisualServer_mesh_get_blend_shape_mode:
  819. - :ref:`int<class_int>` **mesh_get_blend_shape_mode** **(** :ref:`RID<class_rid>` mesh **)** const
  820. Returns a mesh's blend shape mode.
  821. .. _class_VisualServer_mesh_get_custom_aabb:
  822. - :ref:`AABB<class_aabb>` **mesh_get_custom_aabb** **(** :ref:`RID<class_rid>` mesh **)** const
  823. Returns a mesh's custom aabb.
  824. .. _class_VisualServer_mesh_get_surface_count:
  825. - :ref:`int<class_int>` **mesh_get_surface_count** **(** :ref:`RID<class_rid>` mesh **)** const
  826. Returns a mesh's number of surfaces.
  827. .. _class_VisualServer_mesh_remove_surface:
  828. - void **mesh_remove_surface** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` index **)**
  829. Removes a mesh's surface.
  830. .. _class_VisualServer_mesh_set_blend_shape_count:
  831. - void **mesh_set_blend_shape_count** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` amount **)**
  832. Sets a mesh's blend shape count.
  833. .. _class_VisualServer_mesh_set_blend_shape_mode:
  834. - void **mesh_set_blend_shape_mode** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` mode **)**
  835. Sets a mesh's blend shape mode.
  836. .. _class_VisualServer_mesh_set_custom_aabb:
  837. - void **mesh_set_custom_aabb** **(** :ref:`RID<class_rid>` mesh, :ref:`AABB<class_aabb>` aabb **)**
  838. Sets a mesh's custom aabb.
  839. .. _class_VisualServer_mesh_surface_get_aabb:
  840. - :ref:`AABB<class_aabb>` **mesh_surface_get_aabb** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  841. Returns a mesh's surface's aabb.
  842. .. _class_VisualServer_mesh_surface_get_array:
  843. - :ref:`PoolByteArray<class_poolbytearray>` **mesh_surface_get_array** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  844. Returns a mesh's surface's vertex buffer.
  845. .. _class_VisualServer_mesh_surface_get_array_index_len:
  846. - :ref:`int<class_int>` **mesh_surface_get_array_index_len** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  847. Returns a mesh's surface's amount of indices.
  848. .. _class_VisualServer_mesh_surface_get_array_len:
  849. - :ref:`int<class_int>` **mesh_surface_get_array_len** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  850. Returns a mesh's surface's amount of vertices.
  851. .. _class_VisualServer_mesh_surface_get_arrays:
  852. - :ref:`Array<class_array>` **mesh_surface_get_arrays** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  853. Returns a mesh's surface's buffer arrays.
  854. .. _class_VisualServer_mesh_surface_get_blend_shape_arrays:
  855. - :ref:`Array<class_array>` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  856. Returns a mesh's surface's arrays for blend shapes
  857. .. _class_VisualServer_mesh_surface_get_format:
  858. - :ref:`int<class_int>` **mesh_surface_get_format** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  859. Returns the format of a mesh's surface.
  860. .. _class_VisualServer_mesh_surface_get_index_array:
  861. - :ref:`PoolByteArray<class_poolbytearray>` **mesh_surface_get_index_array** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  862. Returns a mesh's surface's index buffer.
  863. .. _class_VisualServer_mesh_surface_get_material:
  864. - :ref:`RID<class_rid>` **mesh_surface_get_material** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  865. Returns a mesh's surface's material.
  866. .. _class_VisualServer_mesh_surface_get_primitive_type:
  867. - :ref:`int<class_int>` **mesh_surface_get_primitive_type** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  868. Returns the primitive type of a mesh's surface.
  869. .. _class_VisualServer_mesh_surface_get_skeleton_aabb:
  870. - :ref:`Array<class_array>` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  871. Returns the aabb of a mesh's surface's skeleton.
  872. .. _class_VisualServer_mesh_surface_set_material:
  873. - void **mesh_surface_set_material** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_rid>` material **)**
  874. Sets a mesh's surface's material.
  875. .. _class_VisualServer_request_frame_drawn_callback:
  876. - void **request_frame_drawn_callback** **(** :ref:`Object<class_object>` where, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata **)**
  877. Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn.
  878. The callback method must use only 1 argument which will be called with 'userdata'.
  879. .. _class_VisualServer_set_boot_image:
  880. - void **set_boot_image** **(** :ref:`Image<class_image>` image, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` scale **)**
  881. Sets a boot image. The color defines the background color and if scale is ``true``, the image will be scaled to fit the screen size.
  882. .. _class_VisualServer_set_debug_generate_wireframes:
  883. - void **set_debug_generate_wireframes** **(** :ref:`bool<class_bool>` generate **)**
  884. .. _class_VisualServer_set_default_clear_color:
  885. - void **set_default_clear_color** **(** :ref:`Color<class_color>` color **)**
  886. .. _class_VisualServer_shader_create:
  887. - :ref:`RID<class_rid>` **shader_create** **(** **)**
  888. Creates an empty shader.
  889. .. _class_VisualServer_shader_get_code:
  890. - :ref:`String<class_string>` **shader_get_code** **(** :ref:`RID<class_rid>` shader **)** const
  891. Returns a shader's code.
  892. .. _class_VisualServer_shader_get_default_texture_param:
  893. - :ref:`RID<class_rid>` **shader_get_default_texture_param** **(** :ref:`RID<class_rid>` shader, :ref:`String<class_string>` name **)** const
  894. Returns a default texture from a shader searched by name.
  895. .. _class_VisualServer_shader_get_param_list:
  896. - :ref:`Array<class_array>` **shader_get_param_list** **(** :ref:`RID<class_rid>` shader **)** const
  897. Returns the parameters of a shader.
  898. .. _class_VisualServer_shader_set_code:
  899. - void **shader_set_code** **(** :ref:`RID<class_rid>` shader, :ref:`String<class_string>` code **)**
  900. Sets a shader's code.
  901. .. _class_VisualServer_shader_set_default_texture_param:
  902. - void **shader_set_default_texture_param** **(** :ref:`RID<class_rid>` shader, :ref:`String<class_string>` name, :ref:`RID<class_rid>` texture **)**
  903. Sets a shader's default texture. Overwrites the texture given by name.
  904. .. _class_VisualServer_sky_create:
  905. - :ref:`RID<class_rid>` **sky_create** **(** **)**
  906. Creates an empty sky.
  907. .. _class_VisualServer_sky_set_texture:
  908. - void **sky_set_texture** **(** :ref:`RID<class_rid>` sky, :ref:`RID<class_rid>` cube_map, :ref:`int<class_int>` radiance_size **)**
  909. Sets a sky's texture.
  910. .. _class_VisualServer_sync:
  911. - void **sync** **(** **)**
  912. .. _class_VisualServer_texture_allocate:
  913. - void **texture_allocate** **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height, :ref:`int<class_int>` format, :ref:`int<class_int>` flags=7 **)**
  914. Allocates space for a texture's image or video.
  915. .. _class_VisualServer_texture_create:
  916. - :ref:`RID<class_rid>` **texture_create** **(** **)**
  917. Creates an empty texture.
  918. .. _class_VisualServer_texture_create_from_image:
  919. - :ref:`RID<class_rid>` **texture_create_from_image** **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)**
  920. Creates a texture, allocates the space for an image, and fills in the image.
  921. .. _class_VisualServer_texture_debug_usage:
  922. - :ref:`Array<class_array>` **texture_debug_usage** **(** **)**
  923. Returns a list of all the textures and their information.
  924. .. _class_VisualServer_texture_get_data:
  925. - :ref:`Image<class_image>` **texture_get_data** **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` cube_side=0 **)** const
  926. Returns a copy of a texture's image unless it's a CubeMap, in wich case it returns the :ref:`RID<class_rid>` of the image at one of the cubes sides.
  927. .. _class_VisualServer_texture_get_flags:
  928. - :ref:`int<class_int>` **texture_get_flags** **(** :ref:`RID<class_rid>` texture **)** const
  929. Returns the flags of a texture.
  930. .. _class_VisualServer_texture_get_format:
  931. - :ref:`int<class_int>` **texture_get_format** **(** :ref:`RID<class_rid>` texture **)** const
  932. Returns the format of the texture's image.
  933. .. _class_VisualServer_texture_get_height:
  934. - :ref:`int<class_int>` **texture_get_height** **(** :ref:`RID<class_rid>` texture **)** const
  935. Returns the texture's height.
  936. .. _class_VisualServer_texture_get_path:
  937. - :ref:`String<class_string>` **texture_get_path** **(** :ref:`RID<class_rid>` texture **)** const
  938. Returns the texture's path.
  939. .. _class_VisualServer_texture_get_texid:
  940. - :ref:`int<class_int>` **texture_get_texid** **(** :ref:`RID<class_rid>` texture **)** const
  941. Returns the opengl id of the texture's image.
  942. .. _class_VisualServer_texture_get_width:
  943. - :ref:`int<class_int>` **texture_get_width** **(** :ref:`RID<class_rid>` texture **)** const
  944. Returns the texture's width.
  945. .. _class_VisualServer_texture_set_data:
  946. - void **texture_set_data** **(** :ref:`RID<class_rid>` texture, :ref:`Image<class_image>` image, :ref:`int<class_int>` cube_side=0 **)**
  947. Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side.
  948. .. _class_VisualServer_texture_set_flags:
  949. - void **texture_set_flags** **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` flags **)**
  950. Sets the texture's flags. See enum TextureFlags for options
  951. .. _class_VisualServer_texture_set_path:
  952. - void **texture_set_path** **(** :ref:`RID<class_rid>` texture, :ref:`String<class_string>` path **)**
  953. Sets the texture's path.
  954. .. _class_VisualServer_texture_set_shrink_all_x2_on_set_data:
  955. - void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool<class_bool>` shrink **)**
  956. If ``true``, sets internal processes to shrink all image data to half the size.
  957. .. _class_VisualServer_texture_set_size_override:
  958. - void **texture_set_size_override** **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
  959. Overwrites the texture's width and height.
  960. .. _class_VisualServer_textures_keep_original:
  961. - void **textures_keep_original** **(** :ref:`bool<class_bool>` enable **)**
  962. If ``true``, the image will be stored in the texture's images array if overwritten.
  963. .. _class_VisualServer_viewport_attach_camera:
  964. - void **viewport_attach_camera** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` camera **)**
  965. Sets a viewport's camera.
  966. .. _class_VisualServer_viewport_attach_canvas:
  967. - void **viewport_attach_canvas** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas **)**
  968. Sets a viewport's canvas.
  969. .. _class_VisualServer_viewport_attach_to_screen:
  970. - void **viewport_attach_to_screen** **(** :ref:`RID<class_rid>` viewport, :ref:`Rect2<class_rect2>` rect=Rect2( 0, 0, 0, 0 ), :ref:`int<class_int>` screen=0 **)**
  971. Attaches a viewport to a screen.
  972. .. _class_VisualServer_viewport_create:
  973. - :ref:`RID<class_rid>` **viewport_create** **(** **)**
  974. Creates an empty viewport.
  975. .. _class_VisualServer_viewport_detach:
  976. - void **viewport_detach** **(** :ref:`RID<class_rid>` viewport **)**
  977. Detaches the viewport from the screen.
  978. .. _class_VisualServer_viewport_get_render_info:
  979. - :ref:`int<class_int>` **viewport_get_render_info** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` info **)**
  980. Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO\* constants.
  981. .. _class_VisualServer_viewport_get_texture:
  982. - :ref:`RID<class_rid>` **viewport_get_texture** **(** :ref:`RID<class_rid>` viewport **)** const
  983. Returns the viewport's last rendered frame.
  984. .. _class_VisualServer_viewport_remove_canvas:
  985. - void **viewport_remove_canvas** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas **)**
  986. Detaches a viewport from a canvas and vice versa.
  987. .. _class_VisualServer_viewport_set_active:
  988. - void **viewport_set_active** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` active **)**
  989. If ``true``, sets the viewport active, else sets it inactive.
  990. .. _class_VisualServer_viewport_set_canvas_layer:
  991. - void **viewport_set_canvas_layer** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas, :ref:`int<class_int>` layer **)**
  992. Sets the renderlayer for a viewport's canvas.
  993. .. _class_VisualServer_viewport_set_canvas_transform:
  994. - void **viewport_set_canvas_transform** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas, :ref:`Transform2D<class_transform2d>` offset **)**
  995. Sets the transformation of a viewport's canvas.
  996. .. _class_VisualServer_viewport_set_clear_mode:
  997. - void **viewport_set_clear_mode** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` clear_mode **)**
  998. Sets the clear mode of a viewport. See VIEWPORT_CLEAR_MODE\_\* constants for options.
  999. .. _class_VisualServer_viewport_set_debug_draw:
  1000. - void **viewport_set_debug_draw** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` draw **)**
  1001. Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW\_\* constants for options.
  1002. .. _class_VisualServer_viewport_set_disable_3d:
  1003. - void **viewport_set_disable_3d** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` disabled **)**
  1004. If ``true`` a viewport's 3D rendering should be disabled.
  1005. .. _class_VisualServer_viewport_set_disable_environment:
  1006. - void **viewport_set_disable_environment** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` disabled **)**
  1007. If ``true`` rendering of a viewport's environment should be disabled.
  1008. .. _class_VisualServer_viewport_set_global_canvas_transform:
  1009. - void **viewport_set_global_canvas_transform** **(** :ref:`RID<class_rid>` viewport, :ref:`Transform2D<class_transform2d>` transform **)**
  1010. Sets the viewport's global transformation matrix.
  1011. .. _class_VisualServer_viewport_set_hdr:
  1012. - void **viewport_set_hdr** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` enabled **)**
  1013. If ``true`` the viewport should render to hdr.
  1014. .. _class_VisualServer_viewport_set_hide_canvas:
  1015. - void **viewport_set_hide_canvas** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` hidden **)**
  1016. If ``true`` the viewport's canvas should not be rendered.
  1017. .. _class_VisualServer_viewport_set_hide_scenario:
  1018. - void **viewport_set_hide_scenario** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` hidden **)**
  1019. .. _class_VisualServer_viewport_set_msaa:
  1020. - void **viewport_set_msaa** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` msaa **)**
  1021. Sets the anti-aliasing mode. see enum ViewportMSAA for options.
  1022. .. _class_VisualServer_viewport_set_parent_viewport:
  1023. - void **viewport_set_parent_viewport** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` parent_viewport **)**
  1024. Sets the viewport's parent to another viewport.
  1025. .. _class_VisualServer_viewport_set_scenario:
  1026. - void **viewport_set_scenario** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` scenario **)**
  1027. Sets a viewport's scenario.
  1028. The scenario contains information about the enum ScenarioDebugMode, environment information, reflection atlas etc.
  1029. .. _class_VisualServer_viewport_set_shadow_atlas_quadrant_subdivision:
  1030. - void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)**
  1031. Sets the shadow atlas quadrant's subdivision.
  1032. .. _class_VisualServer_viewport_set_shadow_atlas_size:
  1033. - void **viewport_set_shadow_atlas_size** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` size **)**
  1034. Sets the size of the shadow atlas's images.
  1035. .. _class_VisualServer_viewport_set_size:
  1036. - void **viewport_set_size** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
  1037. Sets the viewport's width and height.
  1038. .. _class_VisualServer_viewport_set_transparent_background:
  1039. - void **viewport_set_transparent_background** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` enabled **)**
  1040. If ``true`` the viewport should render its background as transparent.
  1041. .. _class_VisualServer_viewport_set_update_mode:
  1042. - void **viewport_set_update_mode** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` update_mode **)**
  1043. Sets when the viewport should be updated. See VIEWPORT_UPDATE_MODE\_\* constants for options.
  1044. .. _class_VisualServer_viewport_set_usage:
  1045. - void **viewport_set_usage** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` usage **)**
  1046. Sets what should be rendered in the viewport. See VIEWPORT_USAGE\_\* constants for options.
  1047. .. _class_VisualServer_viewport_set_use_arvr:
  1048. - void **viewport_set_use_arvr** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` use_arvr **)**
  1049. If ``true`` the viewport should use augmented or virtual reality technologies. See :ref:`ARVRInterface<class_arvrinterface>`.
  1050. .. _class_VisualServer_viewport_set_vflip:
  1051. - void **viewport_set_vflip** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` enabled **)**
  1052. If ``true`` the viewport's rendering should be flipped vertically.