class_visualserver.rst 244 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711
  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. Enums
  380. -----
  381. .. _enum_VisualServer_ViewportRenderInfo:
  382. enum **ViewportRenderInfo**
  383. - **VIEWPORT_RENDER_INFO_OBJECTS_IN_FRAME** = **0**
  384. - **VIEWPORT_RENDER_INFO_VERTICES_IN_FRAME** = **1**
  385. - **VIEWPORT_RENDER_INFO_MATERIAL_CHANGES_IN_FRAME** = **2**
  386. - **VIEWPORT_RENDER_INFO_SHADER_CHANGES_IN_FRAME** = **3**
  387. - **VIEWPORT_RENDER_INFO_SURFACE_CHANGES_IN_FRAME** = **4**
  388. - **VIEWPORT_RENDER_INFO_DRAW_CALLS_IN_FRAME** = **5**
  389. - **VIEWPORT_RENDER_INFO_MAX** = **6** --- Marks end of VIEWPORT_RENDER_INFO\* constants. Used internally.
  390. .. _enum_VisualServer_CubeMapSide:
  391. enum **CubeMapSide**
  392. - **CUBEMAP_LEFT** = **0** --- Marks the left side of a cubemap.
  393. - **CUBEMAP_RIGHT** = **1** --- Marks the right side of a cubemap.
  394. - **CUBEMAP_BOTTOM** = **2** --- Marks the bottom side of a cubemap.
  395. - **CUBEMAP_TOP** = **3** --- Marks the top side of a cubemap.
  396. - **CUBEMAP_FRONT** = **4** --- Marks the front side of a cubemap.
  397. - **CUBEMAP_BACK** = **5** --- Marks the back side of a cubemap.
  398. .. _enum_VisualServer_LightType:
  399. enum **LightType**
  400. - **LIGHT_DIRECTIONAL** = **0** --- Is a directional (sun) light.
  401. - **LIGHT_OMNI** = **1** --- is an omni light.
  402. - **LIGHT_SPOT** = **2** --- is an spot light.
  403. .. _enum_VisualServer_PrimitiveType:
  404. enum **PrimitiveType**
  405. - **PRIMITIVE_POINTS** = **0** --- Primitive to draw consists of points.
  406. - **PRIMITIVE_LINES** = **1** --- Primitive to draw consists of lines.
  407. - **PRIMITIVE_LINE_STRIP** = **2** --- Primitive to draw consists of a line strip from start to end.
  408. - **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).
  409. - **PRIMITIVE_TRIANGLES** = **4** --- Primitive to draw consists of triangles.
  410. - **PRIMITIVE_TRIANGLE_STRIP** = **5** --- Primitive to draw consists of a triangle strip (the last 3 vertices are always combined to make a triangle).
  411. - **PRIMITIVE_TRIANGLE_FAN** = **6** --- Primitive to draw consists of a triangle strip (the last 2 vertices are always combined with the first to make a triangle).
  412. - **PRIMITIVE_MAX** = **7** --- Marks the primitive types endpoint. used internally.
  413. .. _enum_VisualServer_BlendShapeMode:
  414. enum **BlendShapeMode**
  415. - **BLEND_SHAPE_MODE_NORMALIZED** = **0**
  416. - **BLEND_SHAPE_MODE_RELATIVE** = **1**
  417. .. _enum_VisualServer_CanvasOccluderPolygonCullMode:
  418. enum **CanvasOccluderPolygonCullMode**
  419. - **CANVAS_OCCLUDER_POLYGON_CULL_DISABLED** = **0** --- Culling of the canvas occluder is disabled.
  420. - **CANVAS_OCCLUDER_POLYGON_CULL_CLOCKWISE** = **1** --- Culling of the canvas occluder is clockwise.
  421. - **CANVAS_OCCLUDER_POLYGON_CULL_COUNTER_CLOCKWISE** = **2** --- Culling of the canvas occluder is counterclockwise.
  422. .. _enum_VisualServer_ViewportMSAA:
  423. enum **ViewportMSAA**
  424. - **VIEWPORT_MSAA_DISABLED** = **0** --- Multisample antialiasing is disabled.
  425. - **VIEWPORT_MSAA_2X** = **1** --- Multisample antialiasing is set to 2X.
  426. - **VIEWPORT_MSAA_4X** = **2** --- Multisample antialiasing is set to 4X.
  427. - **VIEWPORT_MSAA_8X** = **3** --- Multisample antialiasing is set to 8X.
  428. - **VIEWPORT_MSAA_16X** = **4** --- Multisample antialiasing is set to 16X.
  429. .. _enum_VisualServer_ViewportUpdateMode:
  430. enum **ViewportUpdateMode**
  431. - **VIEWPORT_UPDATE_DISABLED** = **0**
  432. - **VIEWPORT_UPDATE_ONCE** = **1**
  433. - **VIEWPORT_UPDATE_WHEN_VISIBLE** = **2**
  434. - **VIEWPORT_UPDATE_ALWAYS** = **3**
  435. .. _enum_VisualServer_LightParam:
  436. enum **LightParam**
  437. - **LIGHT_PARAM_ENERGY** = **0** --- The light's energy.
  438. - **LIGHT_PARAM_SPECULAR** = **2** --- The light's influence on specularity.
  439. - **LIGHT_PARAM_RANGE** = **3** --- The light's range.
  440. - **LIGHT_PARAM_ATTENUATION** = **4** --- The light's attenuation.
  441. - **LIGHT_PARAM_SPOT_ANGLE** = **5** --- The spotlight's angle.
  442. - **LIGHT_PARAM_SPOT_ATTENUATION** = **6** --- The spotlight's attenuation.
  443. - **LIGHT_PARAM_CONTACT_SHADOW_SIZE** = **7** --- Scales the shadow color.
  444. - **LIGHT_PARAM_SHADOW_MAX_DISTANCE** = **8**
  445. - **LIGHT_PARAM_SHADOW_SPLIT_1_OFFSET** = **9**
  446. - **LIGHT_PARAM_SHADOW_SPLIT_2_OFFSET** = **10**
  447. - **LIGHT_PARAM_SHADOW_SPLIT_3_OFFSET** = **11**
  448. - **LIGHT_PARAM_SHADOW_NORMAL_BIAS** = **12**
  449. - **LIGHT_PARAM_SHADOW_BIAS** = **13**
  450. - **LIGHT_PARAM_SHADOW_BIAS_SPLIT_SCALE** = **14**
  451. - **LIGHT_PARAM_MAX** = **15** --- The light parameters endpoint. Used internally.
  452. .. _enum_VisualServer_ScenarioDebugMode:
  453. enum **ScenarioDebugMode**
  454. - **SCENARIO_DEBUG_DISABLED** = **0**
  455. - **SCENARIO_DEBUG_WIREFRAME** = **1**
  456. - **SCENARIO_DEBUG_OVERDRAW** = **2**
  457. - **SCENARIO_DEBUG_SHADELESS** = **3**
  458. .. _enum_VisualServer_InstanceType:
  459. enum **InstanceType**
  460. - **INSTANCE_NONE** = **0** --- The instance does not have a type.
  461. - **INSTANCE_MESH** = **1** --- The instance is a mesh.
  462. - **INSTANCE_MULTIMESH** = **2** --- The instance is a multimesh.
  463. - **INSTANCE_IMMEDIATE** = **3** --- The instance is an immediate geometry.
  464. - **INSTANCE_PARTICLES** = **4** --- The instance is a particle emitter.
  465. - **INSTANCE_LIGHT** = **5** --- The instance is a light.
  466. - **INSTANCE_REFLECTION_PROBE** = **6**
  467. - **INSTANCE_GI_PROBE** = **7**
  468. - **INSTANCE_LIGHTMAP_CAPTURE** = **8**
  469. - **INSTANCE_MAX** = **9** --- The max value for INSTANCE\_\* constants, used internally.
  470. - **INSTANCE_GEOMETRY_MASK** = **30** --- A combination of the flags of geometry instances (mesh, multimesh, immediate and particles).
  471. .. _enum_VisualServer_ShaderMode:
  472. enum **ShaderMode**
  473. - **SHADER_SPATIAL** = **0** --- Shader is a 3D shader.
  474. - **SHADER_CANVAS_ITEM** = **1** --- Shader is a 2D shader.
  475. - **SHADER_PARTICLES** = **2** --- Shader is a particle shader.
  476. - **SHADER_MAX** = **3** --- Marks maximum of the shader types array. used internally.
  477. .. _enum_VisualServer_ViewportUsage:
  478. enum **ViewportUsage**
  479. - **VIEWPORT_USAGE_2D** = **0** --- The Viewport does not render 3D but samples.
  480. - **VIEWPORT_USAGE_2D_NO_SAMPLING** = **1** --- The Viewport does not render 3D and does not sample.
  481. - **VIEWPORT_USAGE_3D** = **2** --- The Viewport renders 3D with effects.
  482. - **VIEWPORT_USAGE_3D_NO_EFFECTS** = **3** --- The Viewport renders 3D but without effects.
  483. .. _enum_VisualServer_ViewportClearMode:
  484. enum **ViewportClearMode**
  485. - **VIEWPORT_CLEAR_ALWAYS** = **0** --- The viewport is always cleared before drawing.
  486. - **VIEWPORT_CLEAR_NEVER** = **1** --- The viewport is never cleared before drawing.
  487. - **VIEWPORT_CLEAR_ONLY_NEXT_FRAME** = **2** --- The viewport is cleared once, then the clear mode is set to VIEWPORT_CLEAR_NEVER.
  488. .. _enum_VisualServer_ArrayType:
  489. enum **ArrayType**
  490. - **ARRAY_VERTEX** = **0** --- Array is a vertex array.
  491. - **ARRAY_NORMAL** = **1** --- Array is a normal array.
  492. - **ARRAY_TANGENT** = **2** --- Array is a tangent array.
  493. - **ARRAY_COLOR** = **3** --- Array is a color array.
  494. - **ARRAY_TEX_UV** = **4** --- Array is a uv coordinates array.
  495. - **ARRAY_TEX_UV2** = **5** --- Array is a uv coordinates array for the second uv coordinates.
  496. - **ARRAY_BONES** = **6** --- Array contains bone information.
  497. - **ARRAY_WEIGHTS** = **7** --- Array is weight information.
  498. - **ARRAY_INDEX** = **8** --- Array is index array.
  499. - **ARRAY_MAX** = **9** --- Marks the maximum of the array types. Used internally.
  500. .. _enum_VisualServer_CanvasLightMode:
  501. enum **CanvasLightMode**
  502. - **CANVAS_LIGHT_MODE_ADD** = **0** --- Adds light color additive to the canvas.
  503. - **CANVAS_LIGHT_MODE_SUB** = **1** --- Adds light color subtractive to the canvas.
  504. - **CANVAS_LIGHT_MODE_MIX** = **2** --- The light adds color depending on transparency.
  505. - **CANVAS_LIGHT_MODE_MASK** = **3** --- The light adds color depending on mask.
  506. .. _enum_VisualServer_ArrayFormat:
  507. enum **ArrayFormat**
  508. - **ARRAY_FORMAT_VERTEX** = **1** --- Flag used to mark a vertex array.
  509. - **ARRAY_FORMAT_NORMAL** = **2** --- Flag used to mark a normal array.
  510. - **ARRAY_FORMAT_TANGENT** = **4** --- Flag used to mark a tangent array.
  511. - **ARRAY_FORMAT_COLOR** = **8** --- Flag used to mark a color array.
  512. - **ARRAY_FORMAT_TEX_UV** = **16** --- Flag used to mark a uv coordinates array.
  513. - **ARRAY_FORMAT_TEX_UV2** = **32** --- Flag used to mark a uv coordinates array for the second uv coordinates.
  514. - **ARRAY_FORMAT_BONES** = **64** --- Flag used to mark a bone information array.
  515. - **ARRAY_FORMAT_WEIGHTS** = **128** --- Flag used to mark a weights array.
  516. - **ARRAY_FORMAT_INDEX** = **256** --- Flag used to mark a index array.
  517. - **ARRAY_COMPRESS_VERTEX** = **512** --- Flag used to mark a compressed (half float) vertex array.
  518. - **ARRAY_COMPRESS_NORMAL** = **1024** --- Flag used to mark a compressed (half float) normal array.
  519. - **ARRAY_COMPRESS_TANGENT** = **2048** --- Flag used to mark a compressed (half float) tangent array.
  520. - **ARRAY_COMPRESS_COLOR** = **4096** --- Flag used to mark a compressed (half float) color array.
  521. - **ARRAY_COMPRESS_TEX_UV** = **8192** --- Flag used to mark a compressed (half float) uv coordinates array.
  522. - **ARRAY_COMPRESS_TEX_UV2** = **16384** --- Flag used to mark a compressed (half float) uv coordinates array for the second uv coordinates.
  523. - **ARRAY_COMPRESS_BONES** = **32768**
  524. - **ARRAY_COMPRESS_WEIGHTS** = **65536** --- Flag used to mark a compressed (half float) weight array.
  525. - **ARRAY_COMPRESS_INDEX** = **131072**
  526. - **ARRAY_FLAG_USE_2D_VERTICES** = **262144** --- Flag used to mark that the array contains 2D vertices.
  527. - **ARRAY_FLAG_USE_16_BIT_BONES** = **524288** --- Flag used to mark that the array uses 16 bit bones instead of 8 bit.
  528. - **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.
  529. .. _enum_VisualServer_ViewportDebugDraw:
  530. enum **ViewportDebugDraw**
  531. - **VIEWPORT_DEBUG_DRAW_DISABLED** = **0** --- Debug draw is disabled. Default setting.
  532. - **VIEWPORT_DEBUG_DRAW_UNSHADED** = **1** --- Debug draw sets objects to unshaded.
  533. - **VIEWPORT_DEBUG_DRAW_OVERDRAW** = **2** --- Overwrites clear color to ``(0,0,0,0)``.
  534. - **VIEWPORT_DEBUG_DRAW_WIREFRAME** = **3** --- Debug draw draws objects in wireframe.
  535. .. _enum_VisualServer_NinePatchAxisMode:
  536. enum **NinePatchAxisMode**
  537. - **NINE_PATCH_STRETCH** = **0** --- The nine patch gets stretched where needed.
  538. - **NINE_PATCH_TILE** = **1** --- The nine patch gets filled with tiles where needed.
  539. - **NINE_PATCH_TILE_FIT** = **2** --- The nine patch gets filled with tiles where needed and stretches them a bit if needed.
  540. .. _enum_VisualServer_RenderInfo:
  541. enum **RenderInfo**
  542. - **INFO_OBJECTS_IN_FRAME** = **0** --- The amount of objects in the frame.
  543. - **INFO_VERTICES_IN_FRAME** = **1** --- The amount of vertices in the frame.
  544. - **INFO_MATERIAL_CHANGES_IN_FRAME** = **2** --- The amount of modified materials in the frame.
  545. - **INFO_SHADER_CHANGES_IN_FRAME** = **3** --- The amount of shader rebinds in the frame.
  546. - **INFO_SURFACE_CHANGES_IN_FRAME** = **4** --- The amount of surface changes in the frame.
  547. - **INFO_DRAW_CALLS_IN_FRAME** = **5** --- The amount of draw calls in frame.
  548. - **INFO_USAGE_VIDEO_MEM_TOTAL** = **6**
  549. - **INFO_VIDEO_MEM_USED** = **7** --- The amount of vertex memory and texture memory used.
  550. - **INFO_TEXTURE_MEM_USED** = **8** --- The amount of texture memory used.
  551. - **INFO_VERTEX_MEM_USED** = **9** --- The amount of vertex memory used.
  552. .. _enum_VisualServer_CanvasLightShadowFilter:
  553. enum **CanvasLightShadowFilter**
  554. - **CANVAS_LIGHT_FILTER_NONE** = **0**
  555. - **CANVAS_LIGHT_FILTER_PCF3** = **1**
  556. - **CANVAS_LIGHT_FILTER_PCF5** = **2**
  557. - **CANVAS_LIGHT_FILTER_PCF7** = **3**
  558. - **CANVAS_LIGHT_FILTER_PCF9** = **4**
  559. - **CANVAS_LIGHT_FILTER_PCF13** = **5**
  560. .. _enum_VisualServer_Features:
  561. enum **Features**
  562. - **FEATURE_SHADERS** = **0**
  563. - **FEATURE_MULTITHREADED** = **1**
  564. .. _enum_VisualServer_TextureFlags:
  565. enum **TextureFlags**
  566. - **TEXTURE_FLAG_MIPMAPS** = **1** --- Generate mipmaps, which are smaller versions of the same texture to use when zoomed out, keeping the aspect ratio.
  567. - **TEXTURE_FLAG_REPEAT** = **2** --- Repeat (instead of clamp to edge).
  568. - **TEXTURE_FLAG_FILTER** = **4** --- Turn on magnifying filter, to enable smooth zooming in of the texture.
  569. - **TEXTURE_FLAG_ANISOTROPIC_FILTER** = **8** --- Anisotropic mipmap filtering. Generates smaller versions of the same texture with different aspect ratios.
  570. 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.
  571. - **TEXTURE_FLAG_CONVERT_TO_LINEAR** = **16** --- Converts texture to SRGB color space.
  572. - **TEXTURE_FLAG_MIRRORED_REPEAT** = **32** --- Repeat texture with alternate sections mirrored.
  573. - **TEXTURE_FLAG_CUBEMAP** = **2048** --- Texture is a cubemap.
  574. - **TEXTURE_FLAG_USED_FOR_STREAMING** = **4096** --- Texture is a video surface.
  575. - **TEXTURE_FLAGS_DEFAULT** = **7** --- Default flags. Generate mipmaps, repeat, and filter are enabled.
  576. Description
  577. -----------
  578. Server for anything visible. The visual server is the API backend for everything visible. The whole scene system mounts on it to display.
  579. The visual server is completely opaque, the internals are entirely implementation specific and cannot be accessed.
  580. Member Function Description
  581. ---------------------------
  582. .. _class_VisualServer_black_bars_set_images:
  583. - 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 **)**
  584. Sets images to be rendered in the window margin.
  585. .. _class_VisualServer_black_bars_set_margins:
  586. - 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 **)**
  587. Sets margin size, where black bars (or images, if :ref:`black_bars_set_images<class_VisualServer_black_bars_set_images>` was used) are rendered.
  588. .. _class_VisualServer_canvas_create:
  589. - :ref:`RID<class_rid>` **canvas_create** **(** **)**
  590. Creates a canvas and returns the assigned :ref:`RID<class_rid>`.
  591. .. _class_VisualServer_canvas_item_add_circle:
  592. - 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 **)**
  593. Adds a circle command to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  594. .. _class_VisualServer_canvas_item_add_clip_ignore:
  595. - void **canvas_item_add_clip_ignore** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` ignore **)**
  596. If ignore is ``true``, the VisualServer does not perform clipping.
  597. .. _class_VisualServer_canvas_item_add_line:
  598. - 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 **)**
  599. Adds a line command to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  600. .. _class_VisualServer_canvas_item_add_mesh:
  601. - void **canvas_item_add_mesh** **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` mesh, :ref:`RID<class_rid>` skeleton **)**
  602. Adds a :ref:`Mesh<class_mesh>` to the :ref:`CanvasItem<class_canvasitem>`'s draw commands. Only affects its aabb at the moment.
  603. .. _class_VisualServer_canvas_item_add_multimesh:
  604. - void **canvas_item_add_multimesh** **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` mesh, :ref:`RID<class_rid>` skeleton **)**
  605. Adds a :ref:`MultiMesh<class_multimesh>` to the :ref:`CanvasItem<class_canvasitem>`'s draw commands. Only affects its aabb at the moment.
  606. .. _class_VisualServer_canvas_item_add_nine_patch:
  607. - 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 **)**
  608. Adds a nine patch image to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  609. See :ref:`NinePatchRect<class_ninepatchrect>` for more explanation.
  610. .. _class_VisualServer_canvas_item_add_particles:
  611. - 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 **)**
  612. Adds a particles system to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  613. .. _class_VisualServer_canvas_item_add_polygon:
  614. - 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 **)**
  615. Adds a polygon to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  616. .. _class_VisualServer_canvas_item_add_polyline:
  617. - 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 **)**
  618. Adds a polyline, which is a line from multiple points with a width, to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  619. .. _class_VisualServer_canvas_item_add_primitive:
  620. - 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 **)**
  621. Adds a primitive to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  622. .. _class_VisualServer_canvas_item_add_rect:
  623. - void **canvas_item_add_rect** **(** :ref:`RID<class_rid>` item, :ref:`Rect2<class_rect2>` rect, :ref:`Color<class_color>` color **)**
  624. Adds a rectangle to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  625. .. _class_VisualServer_canvas_item_add_set_transform:
  626. - void **canvas_item_add_set_transform** **(** :ref:`RID<class_rid>` item, :ref:`Transform2D<class_transform2d>` transform **)**
  627. Adds a :ref:`Transform2D<class_transform2d>` command to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  628. This sets the extra_matrix uniform when executed. This affects the later command's of the canvas item.
  629. .. _class_VisualServer_canvas_item_add_texture_rect:
  630. - 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 **)**
  631. Adds a textured rect to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  632. .. _class_VisualServer_canvas_item_add_texture_rect_region:
  633. - 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 **)**
  634. Adds a texture rect with region setting to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  635. .. _class_VisualServer_canvas_item_add_triangle_array:
  636. - 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 **)**
  637. Adds a triangle array to the :ref:`CanvasItem<class_canvasitem>`'s draw commands.
  638. .. _class_VisualServer_canvas_item_clear:
  639. - void **canvas_item_clear** **(** :ref:`RID<class_rid>` item **)**
  640. Clears the :ref:`CanvasItem<class_canvasitem>` and removes all commands in it.
  641. .. _class_VisualServer_canvas_item_create:
  642. - :ref:`RID<class_rid>` **canvas_item_create** **(** **)**
  643. Creates a new :ref:`CanvasItem<class_canvasitem>` and returns its :ref:`RID<class_rid>`.
  644. .. _class_VisualServer_canvas_item_set_clip:
  645. - void **canvas_item_set_clip** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` clip **)**
  646. Sets clipping for the :ref:`CanvasItem<class_canvasitem>`.
  647. .. _class_VisualServer_canvas_item_set_copy_to_backbuffer:
  648. - void **canvas_item_set_copy_to_backbuffer** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled, :ref:`Rect2<class_rect2>` rect **)**
  649. Sets the :ref:`CanvasItem<class_canvasitem>` to copy a rect to the backbuffer.
  650. .. _class_VisualServer_canvas_item_set_custom_rect:
  651. - 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 ) **)**
  652. Defines a custom drawing rectangle for the :ref:`CanvasItem<class_canvasitem>`.
  653. .. _class_VisualServer_canvas_item_set_distance_field_mode:
  654. - void **canvas_item_set_distance_field_mode** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  655. .. _class_VisualServer_canvas_item_set_draw_behind_parent:
  656. - void **canvas_item_set_draw_behind_parent** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  657. Sets :ref:`CanvasItem<class_canvasitem>` to be drawn behind its parent.
  658. .. _class_VisualServer_canvas_item_set_draw_index:
  659. - void **canvas_item_set_draw_index** **(** :ref:`RID<class_rid>` item, :ref:`int<class_int>` index **)**
  660. Sets the index for the :ref:`CanvasItem<class_canvasitem>`.
  661. .. _class_VisualServer_canvas_item_set_light_mask:
  662. - void **canvas_item_set_light_mask** **(** :ref:`RID<class_rid>` item, :ref:`int<class_int>` mask **)**
  663. The light mask. See :ref:`LightOccluder2D<class_lightoccluder2d>` for more information on light masks.
  664. .. _class_VisualServer_canvas_item_set_material:
  665. - void **canvas_item_set_material** **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` material **)**
  666. Sets a new material to the :ref:`CanvasItem<class_canvasitem>`.
  667. .. _class_VisualServer_canvas_item_set_modulate:
  668. - void **canvas_item_set_modulate** **(** :ref:`RID<class_rid>` item, :ref:`Color<class_color>` color **)**
  669. Sets the color that modulates the :ref:`CanvasItem<class_canvasitem>` and its children.
  670. .. _class_VisualServer_canvas_item_set_parent:
  671. - void **canvas_item_set_parent** **(** :ref:`RID<class_rid>` item, :ref:`RID<class_rid>` parent **)**
  672. Sets the parent for the :ref:`CanvasItem<class_canvasitem>`.
  673. .. _class_VisualServer_canvas_item_set_self_modulate:
  674. - void **canvas_item_set_self_modulate** **(** :ref:`RID<class_rid>` item, :ref:`Color<class_color>` color **)**
  675. Sets the color that modulates the :ref:`CanvasItem<class_canvasitem>` without children.
  676. .. _class_VisualServer_canvas_item_set_sort_children_by_y:
  677. - void **canvas_item_set_sort_children_by_y** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  678. Sets if :ref:`CanvasItem<class_canvasitem>`'s children should be sorted by y-position.
  679. .. _class_VisualServer_canvas_item_set_transform:
  680. - void **canvas_item_set_transform** **(** :ref:`RID<class_rid>` item, :ref:`Transform2D<class_transform2d>` transform **)**
  681. Sets the :ref:`CanvasItem<class_canvasitem>`'s :ref:`Transform2D<class_transform2d>`.
  682. .. _class_VisualServer_canvas_item_set_use_parent_material:
  683. - void **canvas_item_set_use_parent_material** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  684. Sets if the :ref:`CanvasItem<class_canvasitem>` uses its parent's material.
  685. .. _class_VisualServer_canvas_item_set_visible:
  686. - void **canvas_item_set_visible** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` visible **)**
  687. Sets if the canvas item (including its children) is visible.
  688. .. _class_VisualServer_canvas_item_set_z_as_relative_to_parent:
  689. - void **canvas_item_set_z_as_relative_to_parent** **(** :ref:`RID<class_rid>` item, :ref:`bool<class_bool>` enabled **)**
  690. If this is enabled, the z-index of the parent will be added to the children's z-index.
  691. .. _class_VisualServer_canvas_item_set_z_index:
  692. - void **canvas_item_set_z_index** **(** :ref:`RID<class_rid>` item, :ref:`int<class_int>` z_index **)**
  693. Sets the :ref:`CanvasItem<class_canvasitem>`'s z-index, i.e. its draw order (lower indexes are drawn first).
  694. .. _class_VisualServer_canvas_light_attach_to_canvas:
  695. - void **canvas_light_attach_to_canvas** **(** :ref:`RID<class_rid>` light, :ref:`RID<class_rid>` canvas **)**
  696. Attaches the canvas light to the canvas. Removes it from its previous canvas.
  697. .. _class_VisualServer_canvas_light_create:
  698. - :ref:`RID<class_rid>` **canvas_light_create** **(** **)**
  699. Creates a canvas light.
  700. .. _class_VisualServer_canvas_light_occluder_attach_to_canvas:
  701. - void **canvas_light_occluder_attach_to_canvas** **(** :ref:`RID<class_rid>` occluder, :ref:`RID<class_rid>` canvas **)**
  702. Attaches a light occluder to the canvas. Removes it from its previous canvas.
  703. .. _class_VisualServer_canvas_light_occluder_create:
  704. - :ref:`RID<class_rid>` **canvas_light_occluder_create** **(** **)**
  705. Creates a light occluder.
  706. .. _class_VisualServer_canvas_light_occluder_set_enabled:
  707. - void **canvas_light_occluder_set_enabled** **(** :ref:`RID<class_rid>` occluder, :ref:`bool<class_bool>` enabled **)**
  708. Enables or disables light occluder.
  709. .. _class_VisualServer_canvas_light_occluder_set_light_mask:
  710. - void **canvas_light_occluder_set_light_mask** **(** :ref:`RID<class_rid>` occluder, :ref:`int<class_int>` mask **)**
  711. The light mask. See :ref:`LightOccluder2D<class_lightoccluder2d>` for more information on light masks
  712. .. _class_VisualServer_canvas_light_occluder_set_polygon:
  713. - void **canvas_light_occluder_set_polygon** **(** :ref:`RID<class_rid>` occluder, :ref:`RID<class_rid>` polygon **)**
  714. Sets a light occluder's polygon.
  715. .. _class_VisualServer_canvas_light_occluder_set_transform:
  716. - void **canvas_light_occluder_set_transform** **(** :ref:`RID<class_rid>` occluder, :ref:`Transform2D<class_transform2d>` transform **)**
  717. Sets a light occluder's :ref:`Transform2D<class_transform2d>`.
  718. .. _class_VisualServer_canvas_light_set_color:
  719. - void **canvas_light_set_color** **(** :ref:`RID<class_rid>` light, :ref:`Color<class_color>` color **)**
  720. Sets the color for a light.
  721. .. _class_VisualServer_canvas_light_set_enabled:
  722. - void **canvas_light_set_enabled** **(** :ref:`RID<class_rid>` light, :ref:`bool<class_bool>` enabled **)**
  723. Enables or disables a canvas light.
  724. .. _class_VisualServer_canvas_light_set_energy:
  725. - void **canvas_light_set_energy** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` energy **)**
  726. Sets a canvas light's energy.
  727. .. _class_VisualServer_canvas_light_set_height:
  728. - void **canvas_light_set_height** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` height **)**
  729. Sets a canvas light's height.
  730. .. _class_VisualServer_canvas_light_set_item_cull_mask:
  731. - void **canvas_light_set_item_cull_mask** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` mask **)**
  732. The light mask. See :ref:`LightOccluder2D<class_lightoccluder2d>` for more information on light masks
  733. .. _class_VisualServer_canvas_light_set_item_shadow_cull_mask:
  734. - void **canvas_light_set_item_shadow_cull_mask** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` mask **)**
  735. The shadow mask. binary about which layers this canvas light affects which canvas item's shadows. See :ref:`LightOccluder2D<class_lightoccluder2d>` for more information on light masks.
  736. .. _class_VisualServer_canvas_light_set_layer_range:
  737. - void **canvas_light_set_layer_range** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` min_layer, :ref:`int<class_int>` max_layer **)**
  738. The layer range that gets rendered with this light.
  739. .. _class_VisualServer_canvas_light_set_mode:
  740. - void **canvas_light_set_mode** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` mode **)**
  741. The mode of the light, see CANVAS_LIGHT_MODE\_\* constants.
  742. .. _class_VisualServer_canvas_light_set_scale:
  743. - void **canvas_light_set_scale** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` scale **)**
  744. .. _class_VisualServer_canvas_light_set_shadow_buffer_size:
  745. - void **canvas_light_set_shadow_buffer_size** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` size **)**
  746. Sets the width of the shadow buffer, size gets scaled to the next power of two for this.
  747. .. _class_VisualServer_canvas_light_set_shadow_color:
  748. - void **canvas_light_set_shadow_color** **(** :ref:`RID<class_rid>` light, :ref:`Color<class_color>` color **)**
  749. Sets the color of the canvas light's shadow.
  750. .. _class_VisualServer_canvas_light_set_shadow_enabled:
  751. - void **canvas_light_set_shadow_enabled** **(** :ref:`RID<class_rid>` light, :ref:`bool<class_bool>` enabled **)**
  752. Enables or disables the canvas light's shadow.
  753. .. _class_VisualServer_canvas_light_set_shadow_filter:
  754. - void **canvas_light_set_shadow_filter** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` filter **)**
  755. Sets the canvas light's shadow's filter, see CANVAS_LIGHT_SHADOW_FILTER\_\* constants.
  756. .. _class_VisualServer_canvas_light_set_shadow_gradient_length:
  757. - void **canvas_light_set_shadow_gradient_length** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` length **)**
  758. Sets the length of the shadow's gradient.
  759. .. _class_VisualServer_canvas_light_set_shadow_smooth:
  760. - void **canvas_light_set_shadow_smooth** **(** :ref:`RID<class_rid>` light, :ref:`float<class_float>` smooth **)**
  761. Smoothens the shadow. The lower, the more smooth.
  762. .. _class_VisualServer_canvas_light_set_texture:
  763. - void **canvas_light_set_texture** **(** :ref:`RID<class_rid>` light, :ref:`RID<class_rid>` texture **)**
  764. .. _class_VisualServer_canvas_light_set_texture_offset:
  765. - void **canvas_light_set_texture_offset** **(** :ref:`RID<class_rid>` light, :ref:`Vector2<class_vector2>` offset **)**
  766. .. _class_VisualServer_canvas_light_set_transform:
  767. - void **canvas_light_set_transform** **(** :ref:`RID<class_rid>` light, :ref:`Transform2D<class_transform2d>` transform **)**
  768. Sets the canvas light's :ref:`Transform2D<class_transform2d>`.
  769. .. _class_VisualServer_canvas_light_set_z_range:
  770. - void **canvas_light_set_z_range** **(** :ref:`RID<class_rid>` light, :ref:`int<class_int>` min_z, :ref:`int<class_int>` max_z **)**
  771. .. _class_VisualServer_canvas_occluder_polygon_create:
  772. - :ref:`RID<class_rid>` **canvas_occluder_polygon_create** **(** **)**
  773. Creates a new light occluder polygon.
  774. .. _class_VisualServer_canvas_occluder_polygon_set_cull_mode:
  775. - void **canvas_occluder_polygon_set_cull_mode** **(** :ref:`RID<class_rid>` occluder_polygon, :ref:`int<class_int>` mode **)**
  776. Sets an occluder polygons cull mode. See CANVAS_OCCLUDER_POLYGON_CULL_MODE\_\* constants.
  777. .. _class_VisualServer_canvas_occluder_polygon_set_shape:
  778. - void **canvas_occluder_polygon_set_shape** **(** :ref:`RID<class_rid>` occluder_polygon, :ref:`PoolVector2Array<class_poolvector2array>` shape, :ref:`bool<class_bool>` closed **)**
  779. Sets the shape of the occluder polygon.
  780. .. _class_VisualServer_canvas_occluder_polygon_set_shape_as_lines:
  781. - void **canvas_occluder_polygon_set_shape_as_lines** **(** :ref:`RID<class_rid>` occluder_polygon, :ref:`PoolVector2Array<class_poolvector2array>` shape **)**
  782. Sets the shape of the occluder polygon as lines.
  783. .. _class_VisualServer_canvas_set_item_mirroring:
  784. - void **canvas_set_item_mirroring** **(** :ref:`RID<class_rid>` canvas, :ref:`RID<class_rid>` item, :ref:`Vector2<class_vector2>` mirroring **)**
  785. A copy of the canvas item will be drawn with a local offset of the mirroring :ref:`Vector2<class_vector2>`.
  786. .. _class_VisualServer_canvas_set_modulate:
  787. - void **canvas_set_modulate** **(** :ref:`RID<class_rid>` canvas, :ref:`Color<class_color>` color **)**
  788. Modulates all colors in the given canvas.
  789. .. _class_VisualServer_draw:
  790. - void **draw** **(** :ref:`bool<class_bool>` swap_buffers=true **)**
  791. Draws a frame.
  792. .. _class_VisualServer_finish:
  793. - void **finish** **(** **)**
  794. Removes buffers and clears testcubes.
  795. .. _class_VisualServer_force_draw:
  796. - void **force_draw** **(** :ref:`bool<class_bool>` swap_buffers=true **)**
  797. Draws a frame. Same as :ref:`draw<class_VisualServer_draw>`.
  798. .. _class_VisualServer_force_sync:
  799. - void **force_sync** **(** **)**
  800. Syncronizes threads.
  801. .. _class_VisualServer_free:
  802. - void **free** **(** :ref:`RID<class_rid>` rid **)**
  803. Tries to free an object in the VisualServer.
  804. .. _class_VisualServer_get_render_info:
  805. - :ref:`int<class_int>` **get_render_info** **(** :ref:`int<class_int>` info **)**
  806. Returns a certain information, see RENDER_INFO\_\* for options.
  807. .. _class_VisualServer_get_test_cube:
  808. - :ref:`RID<class_rid>` **get_test_cube** **(** **)**
  809. Returns the id of the test cube. Creates one if none exists.
  810. .. _class_VisualServer_get_test_texture:
  811. - :ref:`RID<class_rid>` **get_test_texture** **(** **)**
  812. Returns the id of the test texture. Creates one if none exists.
  813. .. _class_VisualServer_get_white_texture:
  814. - :ref:`RID<class_rid>` **get_white_texture** **(** **)**
  815. Returns the id of a white texture. Creates one if none exists.
  816. .. _class_VisualServer_has_changed:
  817. - :ref:`bool<class_bool>` **has_changed** **(** **)** const
  818. Returns ``true`` if changes have been made to the VisualServer's data. :ref:`draw<class_VisualServer_draw>` is usually called if this happens.
  819. .. _class_VisualServer_has_feature:
  820. - :ref:`bool<class_bool>` **has_feature** **(** :ref:`int<class_int>` feature **)** const
  821. .. _class_VisualServer_has_os_feature:
  822. - :ref:`bool<class_bool>` **has_os_feature** **(** :ref:`String<class_string>` feature **)** const
  823. Returns true, if the OS supports a certain feature. Features might be s3tc, etc, etc2 and pvrtc,
  824. .. _class_VisualServer_init:
  825. - void **init** **(** **)**
  826. Initializes the visual server.
  827. .. _class_VisualServer_make_sphere_mesh:
  828. - :ref:`RID<class_rid>` **make_sphere_mesh** **(** :ref:`int<class_int>` latitudes, :ref:`int<class_int>` longitudes, :ref:`float<class_float>` radius **)**
  829. Returns a mesh of a sphere with the given amount of horizontal and vertical subdivisions.
  830. .. _class_VisualServer_material_create:
  831. - :ref:`RID<class_rid>` **material_create** **(** **)**
  832. Returns an empty material.
  833. .. _class_VisualServer_material_get_param:
  834. - :ref:`Variant<class_variant>` **material_get_param** **(** :ref:`RID<class_rid>` material, :ref:`String<class_string>` parameter **)** const
  835. Returns the value of a certain material's parameter.
  836. .. _class_VisualServer_material_get_shader:
  837. - :ref:`RID<class_rid>` **material_get_shader** **(** :ref:`RID<class_rid>` shader_material **)** const
  838. Returns the shader of a certain material's shader. Returns an empty RID if the material doesn't have a shader.
  839. .. _class_VisualServer_material_set_line_width:
  840. - void **material_set_line_width** **(** :ref:`RID<class_rid>` material, :ref:`float<class_float>` width **)**
  841. Sets a materials line width.
  842. .. _class_VisualServer_material_set_next_pass:
  843. - void **material_set_next_pass** **(** :ref:`RID<class_rid>` material, :ref:`RID<class_rid>` next_material **)**
  844. Sets an objects next material.
  845. .. _class_VisualServer_material_set_param:
  846. - void **material_set_param** **(** :ref:`RID<class_rid>` material, :ref:`String<class_string>` parameter, :ref:`Variant<class_variant>` value **)**
  847. Sets a materials parameter.
  848. .. _class_VisualServer_material_set_render_priority:
  849. - void **material_set_render_priority** **(** :ref:`RID<class_rid>` material, :ref:`int<class_int>` priority **)**
  850. Sets a material's render priority.
  851. .. _class_VisualServer_material_set_shader:
  852. - void **material_set_shader** **(** :ref:`RID<class_rid>` shader_material, :ref:`RID<class_rid>` shader **)**
  853. Sets a shader material's shader.
  854. .. _class_VisualServer_mesh_add_surface_from_arrays:
  855. - 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 **)**
  856. Adds a surface generated from the Arrays to a mesh. See PRIMITIVE_TYPE\_\* constants for types.
  857. .. _class_VisualServer_mesh_clear:
  858. - void **mesh_clear** **(** :ref:`RID<class_rid>` mesh **)**
  859. Removes all surfaces from a mesh.
  860. .. _class_VisualServer_mesh_create:
  861. - :ref:`RID<class_rid>` **mesh_create** **(** **)**
  862. Creates a new mesh.
  863. .. _class_VisualServer_mesh_get_blend_shape_count:
  864. - :ref:`int<class_int>` **mesh_get_blend_shape_count** **(** :ref:`RID<class_rid>` mesh **)** const
  865. Returns a mesh's blend shape count.
  866. .. _class_VisualServer_mesh_get_blend_shape_mode:
  867. - :ref:`int<class_int>` **mesh_get_blend_shape_mode** **(** :ref:`RID<class_rid>` mesh **)** const
  868. Returns a mesh's blend shape mode.
  869. .. _class_VisualServer_mesh_get_custom_aabb:
  870. - :ref:`AABB<class_aabb>` **mesh_get_custom_aabb** **(** :ref:`RID<class_rid>` mesh **)** const
  871. Returns a mesh's custom aabb.
  872. .. _class_VisualServer_mesh_get_surface_count:
  873. - :ref:`int<class_int>` **mesh_get_surface_count** **(** :ref:`RID<class_rid>` mesh **)** const
  874. Returns a mesh's number of surfaces.
  875. .. _class_VisualServer_mesh_remove_surface:
  876. - void **mesh_remove_surface** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` index **)**
  877. Removes a mesh's surface.
  878. .. _class_VisualServer_mesh_set_blend_shape_count:
  879. - void **mesh_set_blend_shape_count** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` amount **)**
  880. Sets a mesh's blend shape count.
  881. .. _class_VisualServer_mesh_set_blend_shape_mode:
  882. - void **mesh_set_blend_shape_mode** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` mode **)**
  883. Sets a mesh's blend shape mode.
  884. .. _class_VisualServer_mesh_set_custom_aabb:
  885. - void **mesh_set_custom_aabb** **(** :ref:`RID<class_rid>` mesh, :ref:`AABB<class_aabb>` aabb **)**
  886. Sets a mesh's custom aabb.
  887. .. _class_VisualServer_mesh_surface_get_aabb:
  888. - :ref:`AABB<class_aabb>` **mesh_surface_get_aabb** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  889. Returns a mesh's surface's aabb.
  890. .. _class_VisualServer_mesh_surface_get_array:
  891. - :ref:`PoolByteArray<class_poolbytearray>` **mesh_surface_get_array** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  892. Returns a mesh's surface's vertex buffer.
  893. .. _class_VisualServer_mesh_surface_get_array_index_len:
  894. - :ref:`int<class_int>` **mesh_surface_get_array_index_len** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  895. Returns a mesh's surface's amount of indices.
  896. .. _class_VisualServer_mesh_surface_get_array_len:
  897. - :ref:`int<class_int>` **mesh_surface_get_array_len** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  898. Returns a mesh's surface's amount of vertices.
  899. .. _class_VisualServer_mesh_surface_get_arrays:
  900. - :ref:`Array<class_array>` **mesh_surface_get_arrays** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  901. Returns a mesh's surface's buffer arrays.
  902. .. _class_VisualServer_mesh_surface_get_blend_shape_arrays:
  903. - :ref:`Array<class_array>` **mesh_surface_get_blend_shape_arrays** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  904. Returns a mesh's surface's arrays for blend shapes
  905. .. _class_VisualServer_mesh_surface_get_format:
  906. - :ref:`int<class_int>` **mesh_surface_get_format** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  907. Returns the format of a mesh's surface.
  908. .. _class_VisualServer_mesh_surface_get_index_array:
  909. - :ref:`PoolByteArray<class_poolbytearray>` **mesh_surface_get_index_array** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  910. Returns a mesh's surface's index buffer.
  911. .. _class_VisualServer_mesh_surface_get_material:
  912. - :ref:`RID<class_rid>` **mesh_surface_get_material** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  913. Returns a mesh's surface's material.
  914. .. _class_VisualServer_mesh_surface_get_primitive_type:
  915. - :ref:`int<class_int>` **mesh_surface_get_primitive_type** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  916. Returns the primitive type of a mesh's surface.
  917. .. _class_VisualServer_mesh_surface_get_skeleton_aabb:
  918. - :ref:`Array<class_array>` **mesh_surface_get_skeleton_aabb** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface **)** const
  919. Returns the aabb of a mesh's surface's skeleton.
  920. .. _class_VisualServer_mesh_surface_set_material:
  921. - void **mesh_surface_set_material** **(** :ref:`RID<class_rid>` mesh, :ref:`int<class_int>` surface, :ref:`RID<class_rid>` material **)**
  922. Sets a mesh's surface's material.
  923. .. _class_VisualServer_request_frame_drawn_callback:
  924. - void **request_frame_drawn_callback** **(** :ref:`Object<class_object>` where, :ref:`String<class_string>` method, :ref:`Variant<class_variant>` userdata **)**
  925. Schedules a callback to the corresponding named 'method' on 'where' after a frame has been drawn.
  926. The callback method must use only 1 argument which will be called with 'userdata'.
  927. .. _class_VisualServer_set_boot_image:
  928. - void **set_boot_image** **(** :ref:`Image<class_image>` image, :ref:`Color<class_color>` color, :ref:`bool<class_bool>` scale **)**
  929. 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.
  930. .. _class_VisualServer_set_debug_generate_wireframes:
  931. - void **set_debug_generate_wireframes** **(** :ref:`bool<class_bool>` generate **)**
  932. .. _class_VisualServer_set_default_clear_color:
  933. - void **set_default_clear_color** **(** :ref:`Color<class_color>` color **)**
  934. .. _class_VisualServer_shader_create:
  935. - :ref:`RID<class_rid>` **shader_create** **(** **)**
  936. Creates an empty shader.
  937. .. _class_VisualServer_shader_get_code:
  938. - :ref:`String<class_string>` **shader_get_code** **(** :ref:`RID<class_rid>` shader **)** const
  939. Returns a shader's code.
  940. .. _class_VisualServer_shader_get_default_texture_param:
  941. - :ref:`RID<class_rid>` **shader_get_default_texture_param** **(** :ref:`RID<class_rid>` shader, :ref:`String<class_string>` name **)** const
  942. Returns a default texture from a shader searched by name.
  943. .. _class_VisualServer_shader_get_param_list:
  944. - :ref:`Array<class_array>` **shader_get_param_list** **(** :ref:`RID<class_rid>` shader **)** const
  945. Returns the parameters of a shader.
  946. .. _class_VisualServer_shader_set_code:
  947. - void **shader_set_code** **(** :ref:`RID<class_rid>` shader, :ref:`String<class_string>` code **)**
  948. Sets a shader's code.
  949. .. _class_VisualServer_shader_set_default_texture_param:
  950. - void **shader_set_default_texture_param** **(** :ref:`RID<class_rid>` shader, :ref:`String<class_string>` name, :ref:`RID<class_rid>` texture **)**
  951. Sets a shader's default texture. Overwrites the texture given by name.
  952. .. _class_VisualServer_sky_create:
  953. - :ref:`RID<class_rid>` **sky_create** **(** **)**
  954. Creates an empty sky.
  955. .. _class_VisualServer_sky_set_texture:
  956. - void **sky_set_texture** **(** :ref:`RID<class_rid>` sky, :ref:`RID<class_rid>` cube_map, :ref:`int<class_int>` radiance_size **)**
  957. Sets a sky's texture.
  958. .. _class_VisualServer_sync:
  959. - void **sync** **(** **)**
  960. .. _class_VisualServer_texture_allocate:
  961. - 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 **)**
  962. Allocates space for a texture's image or video.
  963. .. _class_VisualServer_texture_create:
  964. - :ref:`RID<class_rid>` **texture_create** **(** **)**
  965. Creates an empty texture.
  966. .. _class_VisualServer_texture_create_from_image:
  967. - :ref:`RID<class_rid>` **texture_create_from_image** **(** :ref:`Image<class_image>` image, :ref:`int<class_int>` flags=7 **)**
  968. Creates a texture, allocates the space for an image, and fills in the image.
  969. .. _class_VisualServer_texture_debug_usage:
  970. - :ref:`Array<class_array>` **texture_debug_usage** **(** **)**
  971. Returns a list of all the textures and their information.
  972. .. _class_VisualServer_texture_get_data:
  973. - :ref:`Image<class_image>` **texture_get_data** **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` cube_side=0 **)** const
  974. Returns a copy of a texture's image unless it's a CubeMap, in which case it returns the :ref:`RID<class_rid>` of the image at one of the cubes sides.
  975. .. _class_VisualServer_texture_get_flags:
  976. - :ref:`int<class_int>` **texture_get_flags** **(** :ref:`RID<class_rid>` texture **)** const
  977. Returns the flags of a texture.
  978. .. _class_VisualServer_texture_get_format:
  979. - :ref:`int<class_int>` **texture_get_format** **(** :ref:`RID<class_rid>` texture **)** const
  980. Returns the format of the texture's image.
  981. .. _class_VisualServer_texture_get_height:
  982. - :ref:`int<class_int>` **texture_get_height** **(** :ref:`RID<class_rid>` texture **)** const
  983. Returns the texture's height.
  984. .. _class_VisualServer_texture_get_path:
  985. - :ref:`String<class_string>` **texture_get_path** **(** :ref:`RID<class_rid>` texture **)** const
  986. Returns the texture's path.
  987. .. _class_VisualServer_texture_get_texid:
  988. - :ref:`int<class_int>` **texture_get_texid** **(** :ref:`RID<class_rid>` texture **)** const
  989. Returns the opengl id of the texture's image.
  990. .. _class_VisualServer_texture_get_width:
  991. - :ref:`int<class_int>` **texture_get_width** **(** :ref:`RID<class_rid>` texture **)** const
  992. Returns the texture's width.
  993. .. _class_VisualServer_texture_set_data:
  994. - void **texture_set_data** **(** :ref:`RID<class_rid>` texture, :ref:`Image<class_image>` image, :ref:`int<class_int>` cube_side=0 **)**
  995. Sets the texture's image data. If it's a CubeMap, it sets the image data at a cube side.
  996. .. _class_VisualServer_texture_set_flags:
  997. - void **texture_set_flags** **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` flags **)**
  998. Sets the texture's flags. See enum TextureFlags for options
  999. .. _class_VisualServer_texture_set_path:
  1000. - void **texture_set_path** **(** :ref:`RID<class_rid>` texture, :ref:`String<class_string>` path **)**
  1001. Sets the texture's path.
  1002. .. _class_VisualServer_texture_set_shrink_all_x2_on_set_data:
  1003. - void **texture_set_shrink_all_x2_on_set_data** **(** :ref:`bool<class_bool>` shrink **)**
  1004. If ``true``, sets internal processes to shrink all image data to half the size.
  1005. .. _class_VisualServer_texture_set_size_override:
  1006. - void **texture_set_size_override** **(** :ref:`RID<class_rid>` texture, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
  1007. Overwrites the texture's width and height.
  1008. .. _class_VisualServer_textures_keep_original:
  1009. - void **textures_keep_original** **(** :ref:`bool<class_bool>` enable **)**
  1010. If ``true``, the image will be stored in the texture's images array if overwritten.
  1011. .. _class_VisualServer_viewport_attach_camera:
  1012. - void **viewport_attach_camera** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` camera **)**
  1013. Sets a viewport's camera.
  1014. .. _class_VisualServer_viewport_attach_canvas:
  1015. - void **viewport_attach_canvas** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas **)**
  1016. Sets a viewport's canvas.
  1017. .. _class_VisualServer_viewport_attach_to_screen:
  1018. - 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 **)**
  1019. Attaches a viewport to a screen.
  1020. .. _class_VisualServer_viewport_create:
  1021. - :ref:`RID<class_rid>` **viewport_create** **(** **)**
  1022. Creates an empty viewport.
  1023. .. _class_VisualServer_viewport_detach:
  1024. - void **viewport_detach** **(** :ref:`RID<class_rid>` viewport **)**
  1025. Detaches the viewport from the screen.
  1026. .. _class_VisualServer_viewport_get_render_info:
  1027. - :ref:`int<class_int>` **viewport_get_render_info** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` info **)**
  1028. Returns a viewport's render info. for options see VIEWPORT_RENDER_INFO\* constants.
  1029. .. _class_VisualServer_viewport_get_texture:
  1030. - :ref:`RID<class_rid>` **viewport_get_texture** **(** :ref:`RID<class_rid>` viewport **)** const
  1031. Returns the viewport's last rendered frame.
  1032. .. _class_VisualServer_viewport_remove_canvas:
  1033. - void **viewport_remove_canvas** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas **)**
  1034. Detaches a viewport from a canvas and vice versa.
  1035. .. _class_VisualServer_viewport_set_active:
  1036. - void **viewport_set_active** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` active **)**
  1037. If ``true``, sets the viewport active, else sets it inactive.
  1038. .. _class_VisualServer_viewport_set_canvas_layer:
  1039. - void **viewport_set_canvas_layer** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas, :ref:`int<class_int>` layer **)**
  1040. Sets the renderlayer for a viewport's canvas.
  1041. .. _class_VisualServer_viewport_set_canvas_transform:
  1042. - void **viewport_set_canvas_transform** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` canvas, :ref:`Transform2D<class_transform2d>` offset **)**
  1043. Sets the transformation of a viewport's canvas.
  1044. .. _class_VisualServer_viewport_set_clear_mode:
  1045. - void **viewport_set_clear_mode** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` clear_mode **)**
  1046. Sets the clear mode of a viewport. See VIEWPORT_CLEAR_MODE\_\* constants for options.
  1047. .. _class_VisualServer_viewport_set_debug_draw:
  1048. - void **viewport_set_debug_draw** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` draw **)**
  1049. Sets the debug draw mode of a viewport. See VIEWPORT_DEBUG_DRAW\_\* constants for options.
  1050. .. _class_VisualServer_viewport_set_disable_3d:
  1051. - void **viewport_set_disable_3d** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` disabled **)**
  1052. If ``true`` a viewport's 3D rendering should be disabled.
  1053. .. _class_VisualServer_viewport_set_disable_environment:
  1054. - void **viewport_set_disable_environment** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` disabled **)**
  1055. If ``true`` rendering of a viewport's environment should be disabled.
  1056. .. _class_VisualServer_viewport_set_global_canvas_transform:
  1057. - void **viewport_set_global_canvas_transform** **(** :ref:`RID<class_rid>` viewport, :ref:`Transform2D<class_transform2d>` transform **)**
  1058. Sets the viewport's global transformation matrix.
  1059. .. _class_VisualServer_viewport_set_hdr:
  1060. - void **viewport_set_hdr** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` enabled **)**
  1061. If ``true`` the viewport should render to hdr.
  1062. .. _class_VisualServer_viewport_set_hide_canvas:
  1063. - void **viewport_set_hide_canvas** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` hidden **)**
  1064. If ``true`` the viewport's canvas should not be rendered.
  1065. .. _class_VisualServer_viewport_set_hide_scenario:
  1066. - void **viewport_set_hide_scenario** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` hidden **)**
  1067. .. _class_VisualServer_viewport_set_msaa:
  1068. - void **viewport_set_msaa** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` msaa **)**
  1069. Sets the anti-aliasing mode. see enum ViewportMSAA for options.
  1070. .. _class_VisualServer_viewport_set_parent_viewport:
  1071. - void **viewport_set_parent_viewport** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` parent_viewport **)**
  1072. Sets the viewport's parent to another viewport.
  1073. .. _class_VisualServer_viewport_set_scenario:
  1074. - void **viewport_set_scenario** **(** :ref:`RID<class_rid>` viewport, :ref:`RID<class_rid>` scenario **)**
  1075. Sets a viewport's scenario.
  1076. The scenario contains information about the enum ScenarioDebugMode, environment information, reflection atlas etc.
  1077. .. _class_VisualServer_viewport_set_shadow_atlas_quadrant_subdivision:
  1078. - void **viewport_set_shadow_atlas_quadrant_subdivision** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` quadrant, :ref:`int<class_int>` subdivision **)**
  1079. Sets the shadow atlas quadrant's subdivision.
  1080. .. _class_VisualServer_viewport_set_shadow_atlas_size:
  1081. - void **viewport_set_shadow_atlas_size** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` size **)**
  1082. Sets the size of the shadow atlas's images.
  1083. .. _class_VisualServer_viewport_set_size:
  1084. - void **viewport_set_size** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` width, :ref:`int<class_int>` height **)**
  1085. Sets the viewport's width and height.
  1086. .. _class_VisualServer_viewport_set_transparent_background:
  1087. - void **viewport_set_transparent_background** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` enabled **)**
  1088. If ``true`` the viewport should render its background as transparent.
  1089. .. _class_VisualServer_viewport_set_update_mode:
  1090. - void **viewport_set_update_mode** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` update_mode **)**
  1091. Sets when the viewport should be updated. See VIEWPORT_UPDATE_MODE\_\* constants for options.
  1092. .. _class_VisualServer_viewport_set_usage:
  1093. - void **viewport_set_usage** **(** :ref:`RID<class_rid>` viewport, :ref:`int<class_int>` usage **)**
  1094. Sets what should be rendered in the viewport. See VIEWPORT_USAGE\_\* constants for options.
  1095. .. _class_VisualServer_viewport_set_use_arvr:
  1096. - void **viewport_set_use_arvr** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` use_arvr **)**
  1097. If ``true`` the viewport should use augmented or virtual reality technologies. See :ref:`ARVRInterface<class_arvrinterface>`.
  1098. .. _class_VisualServer_viewport_set_vflip:
  1099. - void **viewport_set_vflip** **(** :ref:`RID<class_rid>` viewport, :ref:`bool<class_bool>` enabled **)**
  1100. If ``true`` the viewport's rendering should be flipped vertically.