Home Esplora Aiuto
Accedi
godotengine
/
godot-docs
mirror da https://github.com/godotengine/godot-docs
Segui 1
Vota 1
Forka 0
File
Albero (Tree): 9ffd5f53c4
Rami (Branch) Tag
godot-docs
/
classes
/
class_canvasitem.rst

class_canvasitem.rst 172 KB
Cronologia Originale

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/CanvasItem.xml.
    7. 

  7. 

  8. .. _class_CanvasItem:
    9. 

  9. 

  10. CanvasItem
    11. 

  11. ==========
    12. 

  12. 

  13. **Inherits:** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. **Inherited By:** :ref:`Control<class_Control>`, :ref:`Node2D<class_Node2D>`
    16. 

  16. 

  17. Abstract base class for everything in 2D space.
    18. 

  18. 

  19. .. rst-class:: classref-introduction-group
    20. 

  20. 

  21. Description
    22. 

  22. -----------
    23. 

  23. 

  24. Abstract base class for everything in 2D space. Canvas items are laid out in a tree; children inherit and extend their parent's transform. **CanvasItem** is extended by :ref:`Control<class_Control>` for GUI-related nodes, and by :ref:`Node2D<class_Node2D>` for 2D game objects.
    25. 

  25. 

  26. Any **CanvasItem** can draw. For this, :ref:`queue_redraw<class_CanvasItem_method_queue_redraw>` is called by the engine, then :ref:`NOTIFICATION_DRAW<class_CanvasItem_constant_NOTIFICATION_DRAW>` will be received on idle time to request a redraw. Because of this, canvas items don't need to be redrawn on every frame, improving the performance significantly. Several functions for drawing on the **CanvasItem** are provided (see ``draw_*`` functions). However, they can only be used inside :ref:`_draw<class_CanvasItem_private_method__draw>`, its corresponding :ref:`Object._notification<class_Object_private_method__notification>` or methods connected to the :ref:`draw<class_CanvasItem_signal_draw>` signal.
    27. 

  27. 

  28. Canvas items are drawn in tree order on their canvas layer. By default, children are on top of their parents, so a root **CanvasItem** will be drawn behind everything. This behavior can be changed on a per-item basis.
    29. 

  29. 

  30. A **CanvasItem** can be hidden, which will also hide its children. By adjusting various other properties of a **CanvasItem**, you can also modulate its color (via :ref:`modulate<class_CanvasItem_property_modulate>` or :ref:`self_modulate<class_CanvasItem_property_self_modulate>`), change its Z-index, blend mode, and more.
    31. 

  31. 

  32. Note that properties like transform, modulation, and visibility are only propagated to *direct* **CanvasItem** child nodes. If there is a non-**CanvasItem** node in between, like :ref:`Node<class_Node>` or :ref:`AnimationPlayer<class_AnimationPlayer>`, the **CanvasItem** nodes below will have an independent position and :ref:`modulate<class_CanvasItem_property_modulate>` chain. See also :ref:`top_level<class_CanvasItem_property_top_level>`.
    33. 

  33. 

  34. .. rst-class:: classref-introduction-group
    35. 

  35. 

  36. Tutorials
    37. 

  37. ---------
    38. 

  38. 

  39. - :doc:`Viewport and canvas transforms <../tutorials/2d/2d_transforms>`
    40. 

  40. 

  41. - :doc:`Custom drawing in 2D <../tutorials/2d/custom_drawing_in_2d>`
    42. 

  42. 

  43. - `Audio Spectrum Visualizer Demo <https://godotengine.org/asset-library/asset/2762>`__
    44. 

  44. 

  45. .. rst-class:: classref-reftable-group
    46. 

  46. 

  47. Properties
    48. 

  48. ----------
    49. 

  49. 

  50. .. table::
    51. 

  51.    :widths: auto
    52. 

  52. 

  53.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    54. 

  54.    | :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` | :ref:`clip_children<class_CanvasItem_property_clip_children>`             | ``0``                 |
    55. 

  55.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    56. 

  56.    | :ref:`int<class_int>`                                     | :ref:`light_mask<class_CanvasItem_property_light_mask>`                   | ``1``                 |
    57. 

  57.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    58. 

  58.    | :ref:`Material<class_Material>`                           | :ref:`material<class_CanvasItem_property_material>`                       |                       |
    59. 

  59.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    60. 

  60.    | :ref:`Color<class_Color>`                                 | :ref:`modulate<class_CanvasItem_property_modulate>`                       | ``Color(1, 1, 1, 1)`` |
    61. 

  61.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    62. 

  62.    | :ref:`Color<class_Color>`                                 | :ref:`self_modulate<class_CanvasItem_property_self_modulate>`             | ``Color(1, 1, 1, 1)`` |
    63. 

  63.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    64. 

  64.    | :ref:`bool<class_bool>`                                   | :ref:`show_behind_parent<class_CanvasItem_property_show_behind_parent>`   | ``false``             |
    65. 

  65.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    66. 

  66.    | :ref:`TextureFilter<enum_CanvasItem_TextureFilter>`       | :ref:`texture_filter<class_CanvasItem_property_texture_filter>`           | ``0``                 |
    67. 

  67.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    68. 

  68.    | :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>`       | :ref:`texture_repeat<class_CanvasItem_property_texture_repeat>`           | ``0``                 |
    69. 

  69.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    70. 

  70.    | :ref:`bool<class_bool>`                                   | :ref:`top_level<class_CanvasItem_property_top_level>`                     | ``false``             |
    71. 

  71.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    72. 

  72.    | :ref:`bool<class_bool>`                                   | :ref:`use_parent_material<class_CanvasItem_property_use_parent_material>` | ``false``             |
    73. 

  73.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    74. 

  74.    | :ref:`int<class_int>`                                     | :ref:`visibility_layer<class_CanvasItem_property_visibility_layer>`       | ``1``                 |
    75. 

  75.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    76. 

  76.    | :ref:`bool<class_bool>`                                   | :ref:`visible<class_CanvasItem_property_visible>`                         | ``true``              |
    77. 

  77.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    78. 

  78.    | :ref:`bool<class_bool>`                                   | :ref:`y_sort_enabled<class_CanvasItem_property_y_sort_enabled>`           | ``false``             |
    79. 

  79.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    80. 

  80.    | :ref:`bool<class_bool>`                                   | :ref:`z_as_relative<class_CanvasItem_property_z_as_relative>`             | ``true``              |
    81. 

  81.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    82. 

  82.    | :ref:`int<class_int>`                                     | :ref:`z_index<class_CanvasItem_property_z_index>`                         | ``0``                 |
    83. 

  83.    +-----------------------------------------------------------+---------------------------------------------------------------------------+-----------------------+
    84. 

  84. 

  85. .. rst-class:: classref-reftable-group
    86. 

  86. 

  87. Methods
    88. 

  88. -------
    89. 

  89. 

  90. .. table::
    91. 

  91.    :widths: auto
    92. 

  92. 

  93.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    94. 

  94.    | |void|                                | :ref:`_draw<class_CanvasItem_private_method__draw>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    95. 

  95.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    96. 

  96.    | |void|                                | :ref:`draw_animation_slice<class_CanvasItem_method_draw_animation_slice>`\ (\ animation_length\: :ref:`float<class_float>`, slice_begin\: :ref:`float<class_float>`, slice_end\: :ref:`float<class_float>`, offset\: :ref:`float<class_float>` = 0.0\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    97. 

  97.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    98. 

  98.    | |void|                                | :ref:`draw_arc<class_CanvasItem_method_draw_arc>`\ (\ center\: :ref:`Vector2<class_Vector2>`, radius\: :ref:`float<class_float>`, start_angle\: :ref:`float<class_float>`, end_angle\: :ref:`float<class_float>`, point_count\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    99. 

  99.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    100. 

  100.    | |void|                                | :ref:`draw_char<class_CanvasItem_method_draw_char>`\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, char\: :ref:`String<class_String>`, font_size\: :ref:`int<class_int>` = 16, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    101. 

  101.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    102. 

  102.    | |void|                                | :ref:`draw_char_outline<class_CanvasItem_method_draw_char_outline>`\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, char\: :ref:`String<class_String>`, font_size\: :ref:`int<class_int>` = 16, size\: :ref:`int<class_int>` = -1, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    103. 

  103.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    104. 

  104.    | |void|                                | :ref:`draw_circle<class_CanvasItem_method_draw_circle>`\ (\ position\: :ref:`Vector2<class_Vector2>`, radius\: :ref:`float<class_float>`, color\: :ref:`Color<class_Color>`, filled\: :ref:`bool<class_bool>` = true, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    105. 

  105.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    106. 

  106.    | |void|                                | :ref:`draw_colored_polygon<class_CanvasItem_method_draw_colored_polygon>`\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, color\: :ref:`Color<class_Color>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), texture\: :ref:`Texture2D<class_Texture2D>` = null\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
    107. 

  107.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    108. 

  108.    | |void|                                | :ref:`draw_dashed_line<class_CanvasItem_method_draw_dashed_line>`\ (\ from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, dash\: :ref:`float<class_float>` = 2.0, aligned\: :ref:`bool<class_bool>` = true, antialiased\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    109. 

  109.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    110. 

  110.    | |void|                                | :ref:`draw_end_animation<class_CanvasItem_method_draw_end_animation>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
    111. 

  111.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    112. 

  112.    | |void|                                | :ref:`draw_lcd_texture_rect_region<class_CanvasItem_method_draw_lcd_texture_rect_region>`\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, rect\: :ref:`Rect2<class_Rect2>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    113. 

  113.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    114. 

  114.    | |void|                                | :ref:`draw_line<class_CanvasItem_method_draw_line>`\ (\ from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    115. 

  115.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    116. 

  116.    | |void|                                | :ref:`draw_mesh<class_CanvasItem_method_draw_mesh>`\ (\ mesh\: :ref:`Mesh<class_Mesh>`, texture\: :ref:`Texture2D<class_Texture2D>`, transform\: :ref:`Transform2D<class_Transform2D>` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    117. 

  117.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    118. 

  118.    | |void|                                | :ref:`draw_msdf_texture_rect_region<class_CanvasItem_method_draw_msdf_texture_rect_region>`\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, rect\: :ref:`Rect2<class_Rect2>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), outline\: :ref:`float<class_float>` = 0.0, pixel_range\: :ref:`float<class_float>` = 4.0, scale\: :ref:`float<class_float>` = 1.0\ )                                                                                                                                                                                                                                                                                                                                                                                                                               |
    119. 

  119.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    120. 

  120.    | |void|                                | :ref:`draw_multiline<class_CanvasItem_method_draw_multiline>`\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    121. 

  121.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    122. 

  122.    | |void|                                | :ref:`draw_multiline_colors<class_CanvasItem_method_draw_multiline_colors>`\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    123. 

  123.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    124. 

  124.    | |void|                                | :ref:`draw_multiline_string<class_CanvasItem_method_draw_multiline_string>`\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, text\: :ref:`String<class_String>`, alignment\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` = 0, width\: :ref:`float<class_float>` = -1, font_size\: :ref:`int<class_int>` = 16, max_lines\: :ref:`int<class_int>` = -1, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |const|                                                   |
    125. 

  125.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    126. 

  126.    | |void|                                | :ref:`draw_multiline_string_outline<class_CanvasItem_method_draw_multiline_string_outline>`\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, text\: :ref:`String<class_String>`, alignment\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` = 0, width\: :ref:`float<class_float>` = -1, font_size\: :ref:`int<class_int>` = 16, max_lines\: :ref:`int<class_int>` = -1, size\: :ref:`int<class_int>` = 1, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |const| |
    127. 

  127.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    128. 

  128.    | |void|                                | :ref:`draw_multimesh<class_CanvasItem_method_draw_multimesh>`\ (\ multimesh\: :ref:`MultiMesh<class_MultiMesh>`, texture\: :ref:`Texture2D<class_Texture2D>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    129. 

  129.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    130. 

  130.    | |void|                                | :ref:`draw_polygon<class_CanvasItem_method_draw_polygon>`\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), texture\: :ref:`Texture2D<class_Texture2D>` = null\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    131. 

  131.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    132. 

  132.    | |void|                                | :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>`\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
    133. 

  133.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    134. 

  134.    | |void|                                | :ref:`draw_polyline_colors<class_CanvasItem_method_draw_polyline_colors>`\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    135. 

  135.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    136. 

  136.    | |void|                                | :ref:`draw_primitive<class_CanvasItem_method_draw_primitive>`\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>`, texture\: :ref:`Texture2D<class_Texture2D>` = null\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
    137. 

  137.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    138. 

  138.    | |void|                                | :ref:`draw_rect<class_CanvasItem_method_draw_rect>`\ (\ rect\: :ref:`Rect2<class_Rect2>`, color\: :ref:`Color<class_Color>`, filled\: :ref:`bool<class_bool>` = true, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    139. 

  139.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    140. 

  140.    | |void|                                | :ref:`draw_set_transform<class_CanvasItem_method_draw_set_transform>`\ (\ position\: :ref:`Vector2<class_Vector2>`, rotation\: :ref:`float<class_float>` = 0.0, scale\: :ref:`Vector2<class_Vector2>` = Vector2(1, 1)\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    141. 

  141.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    142. 

  142.    | |void|                                | :ref:`draw_set_transform_matrix<class_CanvasItem_method_draw_set_transform_matrix>`\ (\ xform\: :ref:`Transform2D<class_Transform2D>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
    143. 

  143.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    144. 

  144.    | |void|                                | :ref:`draw_string<class_CanvasItem_method_draw_string>`\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, text\: :ref:`String<class_String>`, alignment\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` = 0, width\: :ref:`float<class_float>` = -1, font_size\: :ref:`int<class_int>` = 16, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |const|                                                                                                                                                                                                  |
    145. 

  145.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    146. 

  146.    | |void|                                | :ref:`draw_string_outline<class_CanvasItem_method_draw_string_outline>`\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, text\: :ref:`String<class_String>`, alignment\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` = 0, width\: :ref:`float<class_float>` = -1, font_size\: :ref:`int<class_int>` = 16, size\: :ref:`int<class_int>` = 1, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |const|                                                                                                                                                |
    147. 

  147.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    148. 

  148.    | |void|                                | :ref:`draw_style_box<class_CanvasItem_method_draw_style_box>`\ (\ style_box\: :ref:`StyleBox<class_StyleBox>`, rect\: :ref:`Rect2<class_Rect2>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
    149. 

  149.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    150. 

  150.    | |void|                                | :ref:`draw_texture<class_CanvasItem_method_draw_texture>`\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, position\: :ref:`Vector2<class_Vector2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
    151. 

  151.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    152. 

  152.    | |void|                                | :ref:`draw_texture_rect<class_CanvasItem_method_draw_texture_rect>`\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, rect\: :ref:`Rect2<class_Rect2>`, tile\: :ref:`bool<class_bool>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    153. 

  153.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    154. 

  154.    | |void|                                | :ref:`draw_texture_rect_region<class_CanvasItem_method_draw_texture_rect_region>`\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, rect\: :ref:`Rect2<class_Rect2>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false, clip_uv\: :ref:`bool<class_bool>` = true\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    155. 

  155.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    156. 

  156.    | |void|                                | :ref:`force_update_transform<class_CanvasItem_method_force_update_transform>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    157. 

  157.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    158. 

  158.    | :ref:`RID<class_RID>`                 | :ref:`get_canvas<class_CanvasItem_method_get_canvas>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    159. 

  159.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    160. 

  160.    | :ref:`RID<class_RID>`                 | :ref:`get_canvas_item<class_CanvasItem_method_get_canvas_item>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    161. 

  161.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    162. 

  162.    | :ref:`CanvasLayer<class_CanvasLayer>` | :ref:`get_canvas_layer_node<class_CanvasItem_method_get_canvas_layer_node>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
    163. 

  163.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    164. 

  164.    | :ref:`Transform2D<class_Transform2D>` | :ref:`get_canvas_transform<class_CanvasItem_method_get_canvas_transform>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    165. 

  165.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    166. 

  166.    | :ref:`Vector2<class_Vector2>`         | :ref:`get_global_mouse_position<class_CanvasItem_method_get_global_mouse_position>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    167. 

  167.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    168. 

  168.    | :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform<class_CanvasItem_method_get_global_transform>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    169. 

  169.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    170. 

  170.    | :ref:`Transform2D<class_Transform2D>` | :ref:`get_global_transform_with_canvas<class_CanvasItem_method_get_global_transform_with_canvas>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    171. 

  171.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    172. 

  172.    | :ref:`Vector2<class_Vector2>`         | :ref:`get_local_mouse_position<class_CanvasItem_method_get_local_mouse_position>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    173. 

  173.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    174. 

  174.    | :ref:`Transform2D<class_Transform2D>` | :ref:`get_screen_transform<class_CanvasItem_method_get_screen_transform>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    175. 

  175.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    176. 

  176.    | :ref:`Transform2D<class_Transform2D>` | :ref:`get_transform<class_CanvasItem_method_get_transform>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
    177. 

  177.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    178. 

  178.    | :ref:`Rect2<class_Rect2>`             | :ref:`get_viewport_rect<class_CanvasItem_method_get_viewport_rect>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    179. 

  179.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    180. 

  180.    | :ref:`Transform2D<class_Transform2D>` | :ref:`get_viewport_transform<class_CanvasItem_method_get_viewport_transform>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
    181. 

  181.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    182. 

  182.    | :ref:`bool<class_bool>`               | :ref:`get_visibility_layer_bit<class_CanvasItem_method_get_visibility_layer_bit>`\ (\ layer\: :ref:`int<class_int>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
    183. 

  183.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    184. 

  184.    | :ref:`World2D<class_World2D>`         | :ref:`get_world_2d<class_CanvasItem_method_get_world_2d>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    185. 

  185.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    186. 

  186.    | |void|                                | :ref:`hide<class_CanvasItem_method_hide>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    187. 

  187.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    188. 

  188.    | :ref:`bool<class_bool>`               | :ref:`is_local_transform_notification_enabled<class_CanvasItem_method_is_local_transform_notification_enabled>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    189. 

  189.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    190. 

  190.    | :ref:`bool<class_bool>`               | :ref:`is_transform_notification_enabled<class_CanvasItem_method_is_transform_notification_enabled>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    191. 

  191.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    192. 

  192.    | :ref:`bool<class_bool>`               | :ref:`is_visible_in_tree<class_CanvasItem_method_is_visible_in_tree>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    193. 

  193.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    194. 

  194.    | :ref:`Vector2<class_Vector2>`         | :ref:`make_canvas_position_local<class_CanvasItem_method_make_canvas_position_local>`\ (\ viewport_point\: :ref:`Vector2<class_Vector2>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    195. 

  195.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    196. 

  196.    | :ref:`InputEvent<class_InputEvent>`   | :ref:`make_input_local<class_CanvasItem_method_make_input_local>`\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
    197. 

  197.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    198. 

  198.    | |void|                                | :ref:`move_to_front<class_CanvasItem_method_move_to_front>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    199. 

  199.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    200. 

  200.    | |void|                                | :ref:`queue_redraw<class_CanvasItem_method_queue_redraw>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    201. 

  201.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    202. 

  202.    | |void|                                | :ref:`set_notify_local_transform<class_CanvasItem_method_set_notify_local_transform>`\ (\ enable\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    203. 

  203.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    204. 

  204.    | |void|                                | :ref:`set_notify_transform<class_CanvasItem_method_set_notify_transform>`\ (\ enable\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    205. 

  205.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    206. 

  206.    | |void|                                | :ref:`set_visibility_layer_bit<class_CanvasItem_method_set_visibility_layer_bit>`\ (\ layer\: :ref:`int<class_int>`, enabled\: :ref:`bool<class_bool>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
    207. 

  207.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    208. 

  208.    | |void|                                | :ref:`show<class_CanvasItem_method_show>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    209. 

  209.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    210. 

  210. 

  211. .. rst-class:: classref-section-separator
    212. 

  212. 

  213. ----
    214. 

  214. 

  215. .. rst-class:: classref-descriptions-group
    216. 

  216. 

  217. Signals
    218. 

  218. -------
    219. 

  219. 

  220. .. _class_CanvasItem_signal_draw:
    221. 

  221. 

  222. .. rst-class:: classref-signal
    223. 

  223. 

  224. **draw**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_signal_draw>`
    225. 

  225. 

  226. Emitted when the **CanvasItem** must redraw, *after* the related :ref:`NOTIFICATION_DRAW<class_CanvasItem_constant_NOTIFICATION_DRAW>` notification, and *before* :ref:`_draw<class_CanvasItem_private_method__draw>` is called.
    227. 

  227. 

  228. \ **Note:** Deferred connections do not allow drawing through the ``draw_*`` methods.
    229. 

  229. 

  230. .. rst-class:: classref-item-separator
    231. 

  231. 

  232. ----
    233. 

  233. 

  234. .. _class_CanvasItem_signal_hidden:
    235. 

  235. 

  236. .. rst-class:: classref-signal
    237. 

  237. 

  238. **hidden**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_signal_hidden>`
    239. 

  239. 

  240. Emitted when the **CanvasItem** is hidden, i.e. it's no longer visible in the tree (see :ref:`is_visible_in_tree<class_CanvasItem_method_is_visible_in_tree>`).
    241. 

  241. 

  242. .. rst-class:: classref-item-separator
    243. 

  243. 

  244. ----
    245. 

  245. 

  246. .. _class_CanvasItem_signal_item_rect_changed:
    247. 

  247. 

  248. .. rst-class:: classref-signal
    249. 

  249. 

  250. **item_rect_changed**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_signal_item_rect_changed>`
    251. 

  251. 

  252. Emitted when the **CanvasItem**'s boundaries (position or size) change, or when an action took place that may have affected these boundaries (e.g. changing :ref:`Sprite2D.texture<class_Sprite2D_property_texture>`).
    253. 

  253. 

  254. .. rst-class:: classref-item-separator
    255. 

  255. 

  256. ----
    257. 

  257. 

  258. .. _class_CanvasItem_signal_visibility_changed:
    259. 

  259. 

  260. .. rst-class:: classref-signal
    261. 

  261. 

  262. **visibility_changed**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_signal_visibility_changed>`
    263. 

  263. 

  264. Emitted when the **CanvasItem**'s visibility changes, either because its own :ref:`visible<class_CanvasItem_property_visible>` property changed or because its visibility in the tree changed (see :ref:`is_visible_in_tree<class_CanvasItem_method_is_visible_in_tree>`).
    265. 

  265. 

  266. .. rst-class:: classref-section-separator
    267. 

  267. 

  268. ----
    269. 

  269. 

  270. .. rst-class:: classref-descriptions-group
    271. 

  271. 

  272. Enumerations
    273. 

  273. ------------
    274. 

  274. 

  275. .. _enum_CanvasItem_TextureFilter:
    276. 

  276. 

  277. .. rst-class:: classref-enumeration
    278. 

  278. 

  279. enum **TextureFilter**: :ref:`๐Ÿ”—<enum_CanvasItem_TextureFilter>`
    280. 

  280. 

  281. .. _class_CanvasItem_constant_TEXTURE_FILTER_PARENT_NODE:
    282. 

  282. 

  283. .. rst-class:: classref-enumeration-constant
    284. 

  284. 

  285. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_PARENT_NODE** = ``0``
    286. 

  286. 

  287. The **CanvasItem** will inherit the filter from its parent.
    288. 

  288. 

  289. .. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST:
    290. 

  290. 

  291. .. rst-class:: classref-enumeration-constant
    292. 

  292. 

  293. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_NEAREST** = ``1``
    294. 

  294. 

  295. The texture filter reads from the nearest pixel only. This makes the texture look pixelated from up close, and grainy from a distance (due to mipmaps not being sampled).
    296. 

  296. 

  297. .. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR:
    298. 

  298. 

  299. .. rst-class:: classref-enumeration-constant
    300. 

  300. 

  301. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_LINEAR** = ``2``
    302. 

  302. 

  303. The texture filter blends between the nearest 4 pixels. This makes the texture look smooth from up close, and grainy from a distance (due to mipmaps not being sampled).
    304. 

  304. 

  305. .. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
    306. 

  306. 

  307. .. rst-class:: classref-enumeration-constant
    308. 

  308. 

  309. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3``
    310. 

  310. 

  311. The texture filter reads from the nearest pixel and blends between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look pixelated from up close, and smooth from a distance.
    312. 

  312. 

  313. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
    314. 

  314. 

  315. .. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
    316. 

  316. 

  317. .. rst-class:: classref-enumeration-constant
    318. 

  318. 

  319. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4``
    320. 

  320. 

  321. The texture filter blends between the nearest 4 pixels and between the nearest 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``). This makes the texture look smooth from up close, and smooth from a distance.
    322. 

  322. 

  323. Use this for non-pixel art textures that may be viewed at a low scale (e.g. due to :ref:`Camera2D<class_Camera2D>` zoom or sprite scaling), as mipmaps are important to smooth out pixels that are smaller than on-screen pixels.
    324. 

  324. 

  325. .. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
    326. 

  326. 

  327. .. rst-class:: classref-enumeration-constant
    328. 

  328. 

  329. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5``
    330. 

  330. 

  331. The texture filter reads from the nearest pixel and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look pixelated from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
    332. 

  332. 

  333. \ **Note:** This texture filter is rarely useful in 2D projects. :ref:`TEXTURE_FILTER_NEAREST_WITH_MIPMAPS<class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS>` is usually more appropriate in this case.
    334. 

  334. 

  335. .. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
    336. 

  336. 

  337. .. rst-class:: classref-enumeration-constant
    338. 

  338. 

  339. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6``
    340. 

  340. 

  341. The texture filter blends between the nearest 4 pixels and blends between 2 mipmaps (or uses the nearest mipmap if :ref:`ProjectSettings.rendering/textures/default_filters/use_nearest_mipmap_filter<class_ProjectSettings_property_rendering/textures/default_filters/use_nearest_mipmap_filter>` is ``true``) based on the angle between the surface and the camera view. This makes the texture look smooth from up close, and smooth from a distance. Anisotropic filtering improves texture quality on surfaces that are almost in line with the camera, but is slightly slower. The anisotropic filtering level can be changed by adjusting :ref:`ProjectSettings.rendering/textures/default_filters/anisotropic_filtering_level<class_ProjectSettings_property_rendering/textures/default_filters/anisotropic_filtering_level>`.
    342. 

  342. 

  343. \ **Note:** This texture filter is rarely useful in 2D projects. :ref:`TEXTURE_FILTER_LINEAR_WITH_MIPMAPS<class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS>` is usually more appropriate in this case.
    344. 

  344. 

  345. .. _class_CanvasItem_constant_TEXTURE_FILTER_MAX:
    346. 

  346. 

  347. .. rst-class:: classref-enumeration-constant
    348. 

  348. 

  349. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_MAX** = ``7``
    350. 

  350. 

  351. Represents the size of the :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` enum.
    352. 

  352. 

  353. .. rst-class:: classref-item-separator
    354. 

  354. 

  355. ----
    356. 

  356. 

  357. .. _enum_CanvasItem_TextureRepeat:
    358. 

  358. 

  359. .. rst-class:: classref-enumeration
    360. 

  360. 

  361. enum **TextureRepeat**: :ref:`๐Ÿ”—<enum_CanvasItem_TextureRepeat>`
    362. 

  362. 

  363. .. _class_CanvasItem_constant_TEXTURE_REPEAT_PARENT_NODE:
    364. 

  364. 

  365. .. rst-class:: classref-enumeration-constant
    366. 

  366. 

  367. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_PARENT_NODE** = ``0``
    368. 

  368. 

  369. The **CanvasItem** will inherit the filter from its parent.
    370. 

  370. 

  371. .. _class_CanvasItem_constant_TEXTURE_REPEAT_DISABLED:
    372. 

  372. 

  373. .. rst-class:: classref-enumeration-constant
    374. 

  374. 

  375. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_DISABLED** = ``1``
    376. 

  376. 

  377. Texture will not repeat.
    378. 

  378. 

  379. .. _class_CanvasItem_constant_TEXTURE_REPEAT_ENABLED:
    380. 

  380. 

  381. .. rst-class:: classref-enumeration-constant
    382. 

  382. 

  383. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_ENABLED** = ``2``
    384. 

  384. 

  385. Texture will repeat normally.
    386. 

  386. 

  387. .. _class_CanvasItem_constant_TEXTURE_REPEAT_MIRROR:
    388. 

  388. 

  389. .. rst-class:: classref-enumeration-constant
    390. 

  390. 

  391. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_MIRROR** = ``3``
    392. 

  392. 

  393. Texture will repeat in a 2ร—2 tiled mode, where elements at even positions are mirrored.
    394. 

  394. 

  395. .. _class_CanvasItem_constant_TEXTURE_REPEAT_MAX:
    396. 

  396. 

  397. .. rst-class:: classref-enumeration-constant
    398. 

  398. 

  399. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_MAX** = ``4``
    400. 

  400. 

  401. Represents the size of the :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` enum.
    402. 

  402. 

  403. .. rst-class:: classref-item-separator
    404. 

  404. 

  405. ----
    406. 

  406. 

  407. .. _enum_CanvasItem_ClipChildrenMode:
    408. 

  408. 

  409. .. rst-class:: classref-enumeration
    410. 

  410. 

  411. enum **ClipChildrenMode**: :ref:`๐Ÿ”—<enum_CanvasItem_ClipChildrenMode>`
    412. 

  412. 

  413. .. _class_CanvasItem_constant_CLIP_CHILDREN_DISABLED:
    414. 

  414. 

  415. .. rst-class:: classref-enumeration-constant
    416. 

  416. 

  417. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **CLIP_CHILDREN_DISABLED** = ``0``
    418. 

  418. 

  419. Child draws over parent and is not clipped.
    420. 

  420. 

  421. .. _class_CanvasItem_constant_CLIP_CHILDREN_ONLY:
    422. 

  422. 

  423. .. rst-class:: classref-enumeration-constant
    424. 

  424. 

  425. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **CLIP_CHILDREN_ONLY** = ``1``
    426. 

  426. 

  427. Parent is used for the purposes of clipping only. Child is clipped to the parent's visible area, parent is not drawn.
    428. 

  428. 

  429. .. _class_CanvasItem_constant_CLIP_CHILDREN_AND_DRAW:
    430. 

  430. 

  431. .. rst-class:: classref-enumeration-constant
    432. 

  432. 

  433. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **CLIP_CHILDREN_AND_DRAW** = ``2``
    434. 

  434. 

  435. Parent is used for clipping child, but parent is also drawn underneath child as normal before clipping child to its visible area.
    436. 

  436. 

  437. .. _class_CanvasItem_constant_CLIP_CHILDREN_MAX:
    438. 

  438. 

  439. .. rst-class:: classref-enumeration-constant
    440. 

  440. 

  441. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **CLIP_CHILDREN_MAX** = ``3``
    442. 

  442. 

  443. Represents the size of the :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` enum.
    444. 

  444. 

  445. .. rst-class:: classref-section-separator
    446. 

  446. 

  447. ----
    448. 

  448. 

  449. .. rst-class:: classref-descriptions-group
    450. 

  450. 

  451. Constants
    452. 

  452. ---------
    453. 

  453. 

  454. .. _class_CanvasItem_constant_NOTIFICATION_TRANSFORM_CHANGED:
    455. 

  455. 

  456. .. rst-class:: classref-constant
    457. 

  457. 

  458. **NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` :ref:`๐Ÿ”—<class_CanvasItem_constant_NOTIFICATION_TRANSFORM_CHANGED>`
    459. 

  459. 

  460. The **CanvasItem**'s global transform has changed. This notification is only received if enabled by :ref:`set_notify_transform<class_CanvasItem_method_set_notify_transform>`.
    461. 

  461. 

  462. .. _class_CanvasItem_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED:
    463. 

  463. 

  464. .. rst-class:: classref-constant
    465. 

  465. 

  466. **NOTIFICATION_LOCAL_TRANSFORM_CHANGED** = ``35`` :ref:`๐Ÿ”—<class_CanvasItem_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED>`
    467. 

  467. 

  468. The **CanvasItem**'s local transform has changed. This notification is only received if enabled by :ref:`set_notify_local_transform<class_CanvasItem_method_set_notify_local_transform>`.
    469. 

  469. 

  470. .. _class_CanvasItem_constant_NOTIFICATION_DRAW:
    471. 

  471. 

  472. .. rst-class:: classref-constant
    473. 

  473. 

  474. **NOTIFICATION_DRAW** = ``30`` :ref:`๐Ÿ”—<class_CanvasItem_constant_NOTIFICATION_DRAW>`
    475. 

  475. 

  476. The **CanvasItem** is requested to draw (see :ref:`_draw<class_CanvasItem_private_method__draw>`).
    477. 

  477. 

  478. .. _class_CanvasItem_constant_NOTIFICATION_VISIBILITY_CHANGED:
    479. 

  479. 

  480. .. rst-class:: classref-constant
    481. 

  481. 

  482. **NOTIFICATION_VISIBILITY_CHANGED** = ``31`` :ref:`๐Ÿ”—<class_CanvasItem_constant_NOTIFICATION_VISIBILITY_CHANGED>`
    483. 

  483. 

  484. The **CanvasItem**'s visibility has changed.
    485. 

  485. 

  486. .. _class_CanvasItem_constant_NOTIFICATION_ENTER_CANVAS:
    487. 

  487. 

  488. .. rst-class:: classref-constant
    489. 

  489. 

  490. **NOTIFICATION_ENTER_CANVAS** = ``32`` :ref:`๐Ÿ”—<class_CanvasItem_constant_NOTIFICATION_ENTER_CANVAS>`
    491. 

  491. 

  492. The **CanvasItem** has entered the canvas.
    493. 

  493. 

  494. .. _class_CanvasItem_constant_NOTIFICATION_EXIT_CANVAS:
    495. 

  495. 

  496. .. rst-class:: classref-constant
    497. 

  497. 

  498. **NOTIFICATION_EXIT_CANVAS** = ``33`` :ref:`๐Ÿ”—<class_CanvasItem_constant_NOTIFICATION_EXIT_CANVAS>`
    499. 

  499. 

  500. The **CanvasItem** has exited the canvas.
    501. 

  501. 

  502. .. _class_CanvasItem_constant_NOTIFICATION_WORLD_2D_CHANGED:
    503. 

  503. 

  504. .. rst-class:: classref-constant
    505. 

  505. 

  506. **NOTIFICATION_WORLD_2D_CHANGED** = ``36`` :ref:`๐Ÿ”—<class_CanvasItem_constant_NOTIFICATION_WORLD_2D_CHANGED>`
    507. 

  507. 

  508. The **CanvasItem**'s active :ref:`World2D<class_World2D>` changed.
    509. 

  509. 

  510. .. rst-class:: classref-section-separator
    511. 

  511. 

  512. ----
    513. 

  513. 

  514. .. rst-class:: classref-descriptions-group
    515. 

  515. 

  516. Property Descriptions
    517. 

  517. ---------------------
    518. 

  518. 

  519. .. _class_CanvasItem_property_clip_children:
    520. 

  520. 

  521. .. rst-class:: classref-property
    522. 

  522. 

  523. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **clip_children** = ``0`` :ref:`๐Ÿ”—<class_CanvasItem_property_clip_children>`
    524. 

  524. 

  525. .. rst-class:: classref-property-setget
    526. 

  526. 

  527. - |void| **set_clip_children_mode**\ (\ value\: :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>`\ )
    528. 

  528. - :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **get_clip_children_mode**\ (\ )
    529. 

  529. 

  530. Allows the current node to clip child nodes, essentially acting as a mask.
    531. 

  531. 

  532. \ **Note:** Clipping nodes cannot be nested or placed within :ref:`CanvasGroup<class_CanvasGroup>`\ s. If an ancestor of this node clips its children or is a :ref:`CanvasGroup<class_CanvasGroup>`, then this node's clip mode should be set to :ref:`CLIP_CHILDREN_DISABLED<class_CanvasItem_constant_CLIP_CHILDREN_DISABLED>` to avoid unexpected behavior.
    533. 

  533. 

  534. .. rst-class:: classref-item-separator
    535. 

  535. 

  536. ----
    537. 

  537. 

  538. .. _class_CanvasItem_property_light_mask:
    539. 

  539. 

  540. .. rst-class:: classref-property
    541. 

  541. 

  542. :ref:`int<class_int>` **light_mask** = ``1`` :ref:`๐Ÿ”—<class_CanvasItem_property_light_mask>`
    543. 

  543. 

  544. .. rst-class:: classref-property-setget
    545. 

  545. 

  546. - |void| **set_light_mask**\ (\ value\: :ref:`int<class_int>`\ )
    547. 

  547. - :ref:`int<class_int>` **get_light_mask**\ (\ )
    548. 

  548. 

  549. The rendering layers in which this **CanvasItem** responds to :ref:`Light2D<class_Light2D>` nodes.
    550. 

  550. 

  551. .. rst-class:: classref-item-separator
    552. 

  552. 

  553. ----
    554. 

  554. 

  555. .. _class_CanvasItem_property_material:
    556. 

  556. 

  557. .. rst-class:: classref-property
    558. 

  558. 

  559. :ref:`Material<class_Material>` **material** :ref:`๐Ÿ”—<class_CanvasItem_property_material>`
    560. 

  560. 

  561. .. rst-class:: classref-property-setget
    562. 

  562. 

  563. - |void| **set_material**\ (\ value\: :ref:`Material<class_Material>`\ )
    564. 

  564. - :ref:`Material<class_Material>` **get_material**\ (\ )
    565. 

  565. 

  566. The material applied to this **CanvasItem**.
    567. 

  567. 

  568. .. rst-class:: classref-item-separator
    569. 

  569. 

  570. ----
    571. 

  571. 

  572. .. _class_CanvasItem_property_modulate:
    573. 

  573. 

  574. .. rst-class:: classref-property
    575. 

  575. 

  576. :ref:`Color<class_Color>` **modulate** = ``Color(1, 1, 1, 1)`` :ref:`๐Ÿ”—<class_CanvasItem_property_modulate>`
    577. 

  577. 

  578. .. rst-class:: classref-property-setget
    579. 

  579. 

  580. - |void| **set_modulate**\ (\ value\: :ref:`Color<class_Color>`\ )
    581. 

  581. - :ref:`Color<class_Color>` **get_modulate**\ (\ )
    582. 

  582. 

  583. The color applied to this **CanvasItem**. This property does affect child **CanvasItem**\ s, unlike :ref:`self_modulate<class_CanvasItem_property_self_modulate>` which only affects the node itself.
    584. 

  584. 

  585. .. rst-class:: classref-item-separator
    586. 

  586. 

  587. ----
    588. 

  588. 

  589. .. _class_CanvasItem_property_self_modulate:
    590. 

  590. 

  591. .. rst-class:: classref-property
    592. 

  592. 

  593. :ref:`Color<class_Color>` **self_modulate** = ``Color(1, 1, 1, 1)`` :ref:`๐Ÿ”—<class_CanvasItem_property_self_modulate>`
    594. 

  594. 

  595. .. rst-class:: classref-property-setget
    596. 

  596. 

  597. - |void| **set_self_modulate**\ (\ value\: :ref:`Color<class_Color>`\ )
    598. 

  598. - :ref:`Color<class_Color>` **get_self_modulate**\ (\ )
    599. 

  599. 

  600. The color applied to this **CanvasItem**. This property does **not** affect child **CanvasItem**\ s, unlike :ref:`modulate<class_CanvasItem_property_modulate>` which affects both the node itself and its children.
    601. 

  601. 

  602. \ **Note:** Internal children (e.g. sliders in :ref:`ColorPicker<class_ColorPicker>` or tab bar in :ref:`TabContainer<class_TabContainer>`) are also not affected by this property (see ``include_internal`` parameter of :ref:`Node.get_child<class_Node_method_get_child>` and other similar methods).
    603. 

  603. 

  604. .. rst-class:: classref-item-separator
    605. 

  605. 

  606. ----
    607. 

  607. 

  608. .. _class_CanvasItem_property_show_behind_parent:
    609. 

  609. 

  610. .. rst-class:: classref-property
    611. 

  611. 

  612. :ref:`bool<class_bool>` **show_behind_parent** = ``false`` :ref:`๐Ÿ”—<class_CanvasItem_property_show_behind_parent>`
    613. 

  613. 

  614. .. rst-class:: classref-property-setget
    615. 

  615. 

  616. - |void| **set_draw_behind_parent**\ (\ value\: :ref:`bool<class_bool>`\ )
    617. 

  617. - :ref:`bool<class_bool>` **is_draw_behind_parent_enabled**\ (\ )
    618. 

  618. 

  619. If ``true``, the object draws behind its parent.
    620. 

  620. 

  621. .. rst-class:: classref-item-separator
    622. 

  622. 

  623. ----
    624. 

  624. 

  625. .. _class_CanvasItem_property_texture_filter:
    626. 

  626. 

  627. .. rst-class:: classref-property
    628. 

  628. 

  629. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **texture_filter** = ``0`` :ref:`๐Ÿ”—<class_CanvasItem_property_texture_filter>`
    630. 

  630. 

  631. .. rst-class:: classref-property-setget
    632. 

  632. 

  633. - |void| **set_texture_filter**\ (\ value\: :ref:`TextureFilter<enum_CanvasItem_TextureFilter>`\ )
    634. 

  634. - :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **get_texture_filter**\ (\ )
    635. 

  635. 

  636. The texture filtering mode to use on this **CanvasItem**.
    637. 

  637. 

  638. .. rst-class:: classref-item-separator
    639. 

  639. 

  640. ----
    641. 

  641. 

  642. .. _class_CanvasItem_property_texture_repeat:
    643. 

  643. 

  644. .. rst-class:: classref-property
    645. 

  645. 

  646. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **texture_repeat** = ``0`` :ref:`๐Ÿ”—<class_CanvasItem_property_texture_repeat>`
    647. 

  647. 

  648. .. rst-class:: classref-property-setget
    649. 

  649. 

  650. - |void| **set_texture_repeat**\ (\ value\: :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>`\ )
    651. 

  651. - :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **get_texture_repeat**\ (\ )
    652. 

  652. 

  653. The texture repeating mode to use on this **CanvasItem**.
    654. 

  654. 

  655. .. rst-class:: classref-item-separator
    656. 

  656. 

  657. ----
    658. 

  658. 

  659. .. _class_CanvasItem_property_top_level:
    660. 

  660. 

  661. .. rst-class:: classref-property
    662. 

  662. 

  663. :ref:`bool<class_bool>` **top_level** = ``false`` :ref:`๐Ÿ”—<class_CanvasItem_property_top_level>`
    664. 

  664. 

  665. .. rst-class:: classref-property-setget
    666. 

  666. 

  667. - |void| **set_as_top_level**\ (\ value\: :ref:`bool<class_bool>`\ )
    668. 

  668. - :ref:`bool<class_bool>` **is_set_as_top_level**\ (\ )
    669. 

  669. 

  670. If ``true``, this **CanvasItem** will *not* inherit its transform from parent **CanvasItem**\ s. Its draw order will also be changed to make it draw on top of other **CanvasItem**\ s that do not have :ref:`top_level<class_CanvasItem_property_top_level>` set to ``true``. The **CanvasItem** will effectively act as if it was placed as a child of a bare :ref:`Node<class_Node>`.
    671. 

  671. 

  672. .. rst-class:: classref-item-separator
    673. 

  673. 

  674. ----
    675. 

  675. 

  676. .. _class_CanvasItem_property_use_parent_material:
    677. 

  677. 

  678. .. rst-class:: classref-property
    679. 

  679. 

  680. :ref:`bool<class_bool>` **use_parent_material** = ``false`` :ref:`๐Ÿ”—<class_CanvasItem_property_use_parent_material>`
    681. 

  681. 

  682. .. rst-class:: classref-property-setget
    683. 

  683. 

  684. - |void| **set_use_parent_material**\ (\ value\: :ref:`bool<class_bool>`\ )
    685. 

  685. - :ref:`bool<class_bool>` **get_use_parent_material**\ (\ )
    686. 

  686. 

  687. If ``true``, the parent **CanvasItem**'s :ref:`material<class_CanvasItem_property_material>` property is used as this one's material.
    688. 

  688. 

  689. .. rst-class:: classref-item-separator
    690. 

  690. 

  691. ----
    692. 

  692. 

  693. .. _class_CanvasItem_property_visibility_layer:
    694. 

  694. 

  695. .. rst-class:: classref-property
    696. 

  696. 

  697. :ref:`int<class_int>` **visibility_layer** = ``1`` :ref:`๐Ÿ”—<class_CanvasItem_property_visibility_layer>`
    698. 

  698. 

  699. .. rst-class:: classref-property-setget
    700. 

  700. 

  701. - |void| **set_visibility_layer**\ (\ value\: :ref:`int<class_int>`\ )
    702. 

  702. - :ref:`int<class_int>` **get_visibility_layer**\ (\ )
    703. 

  703. 

  704. The rendering layer in which this **CanvasItem** is rendered by :ref:`Viewport<class_Viewport>` nodes. A :ref:`Viewport<class_Viewport>` will render a **CanvasItem** if it and all its parents share a layer with the :ref:`Viewport<class_Viewport>`'s canvas cull mask.
    705. 

  705. 

  706. .. rst-class:: classref-item-separator
    707. 

  707. 

  708. ----
    709. 

  709. 

  710. .. _class_CanvasItem_property_visible:
    711. 

  711. 

  712. .. rst-class:: classref-property
    713. 

  713. 

  714. :ref:`bool<class_bool>` **visible** = ``true`` :ref:`๐Ÿ”—<class_CanvasItem_property_visible>`
    715. 

  715. 

  716. .. rst-class:: classref-property-setget
    717. 

  717. 

  718. - |void| **set_visible**\ (\ value\: :ref:`bool<class_bool>`\ )
    719. 

  719. - :ref:`bool<class_bool>` **is_visible**\ (\ )
    720. 

  720. 

  721. If ``true``, this **CanvasItem** may be drawn. Whether this **CanvasItem** is actually drawn depends on the visibility of all of its **CanvasItem** ancestors. In other words: this **CanvasItem** will be drawn when :ref:`is_visible_in_tree<class_CanvasItem_method_is_visible_in_tree>` returns ``true`` and all **CanvasItem** ancestors share at least one :ref:`visibility_layer<class_CanvasItem_property_visibility_layer>` with this **CanvasItem**.
    722. 

  722. 

  723. \ **Note:** For controls that inherit :ref:`Popup<class_Popup>`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead.
    724. 

  724. 

  725. .. rst-class:: classref-item-separator
    726. 

  726. 

  727. ----
    728. 

  728. 

  729. .. _class_CanvasItem_property_y_sort_enabled:
    730. 

  730. 

  731. .. rst-class:: classref-property
    732. 

  732. 

  733. :ref:`bool<class_bool>` **y_sort_enabled** = ``false`` :ref:`๐Ÿ”—<class_CanvasItem_property_y_sort_enabled>`
    734. 

  734. 

  735. .. rst-class:: classref-property-setget
    736. 

  736. 

  737. - |void| **set_y_sort_enabled**\ (\ value\: :ref:`bool<class_bool>`\ )
    738. 

  738. - :ref:`bool<class_bool>` **is_y_sort_enabled**\ (\ )
    739. 

  739. 

  740. If ``true``, this and child **CanvasItem** nodes with a higher Y position are rendered in front of nodes with a lower Y position. If ``false``, this and child **CanvasItem** nodes are rendered normally in scene tree order.
    741. 

  741. 

  742. With Y-sorting enabled on a parent node ('A') but disabled on a child node ('B'), the child node ('B') is sorted but its children ('C1', 'C2', etc.) render together on the same Y position as the child node ('B'). This allows you to organize the render order of a scene without changing the scene tree.
    743. 

  743. 

  744. Nodes sort relative to each other only if they are on the same :ref:`z_index<class_CanvasItem_property_z_index>`.
    745. 

  745. 

  746. .. rst-class:: classref-item-separator
    747. 

  747. 

  748. ----
    749. 

  749. 

  750. .. _class_CanvasItem_property_z_as_relative:
    751. 

  751. 

  752. .. rst-class:: classref-property
    753. 

  753. 

  754. :ref:`bool<class_bool>` **z_as_relative** = ``true`` :ref:`๐Ÿ”—<class_CanvasItem_property_z_as_relative>`
    755. 

  755. 

  756. .. rst-class:: classref-property-setget
    757. 

  757. 

  758. - |void| **set_z_as_relative**\ (\ value\: :ref:`bool<class_bool>`\ )
    759. 

  759. - :ref:`bool<class_bool>` **is_z_relative**\ (\ )
    760. 

  760. 

  761. If ``true``, the node's Z index is relative to its parent's Z index. If this node's Z index is 2 and its parent's effective Z index is 3, then this node's effective Z index will be 2 + 3 = 5.
    762. 

  762. 

  763. .. rst-class:: classref-item-separator
    764. 

  764. 

  765. ----
    766. 

  766. 

  767. .. _class_CanvasItem_property_z_index:
    768. 

  768. 

  769. .. rst-class:: classref-property
    770. 

  770. 

  771. :ref:`int<class_int>` **z_index** = ``0`` :ref:`๐Ÿ”—<class_CanvasItem_property_z_index>`
    772. 

  772. 

  773. .. rst-class:: classref-property-setget
    774. 

  774. 

  775. - |void| **set_z_index**\ (\ value\: :ref:`int<class_int>`\ )
    776. 

  776. - :ref:`int<class_int>` **get_z_index**\ (\ )
    777. 

  777. 

  778. Controls the order in which the nodes render. A node with a higher Z index will display in front of others. Must be between :ref:`RenderingServer.CANVAS_ITEM_Z_MIN<class_RenderingServer_constant_CANVAS_ITEM_Z_MIN>` and :ref:`RenderingServer.CANVAS_ITEM_Z_MAX<class_RenderingServer_constant_CANVAS_ITEM_Z_MAX>` (inclusive).
    779. 

  779. 

  780. \ **Note:** Changing the Z index of a :ref:`Control<class_Control>` only affects the drawing order, not the order in which input events are handled. This can be useful to implement certain UI animations, e.g. a menu where hovered items are scaled and should overlap others.
    781. 

  781. 

  782. .. rst-class:: classref-section-separator
    783. 

  783. 

  784. ----
    785. 

  785. 

  786. .. rst-class:: classref-descriptions-group
    787. 

  787. 

  788. Method Descriptions
    789. 

  789. -------------------
    790. 

  790. 

  791. .. _class_CanvasItem_private_method__draw:
    792. 

  792. 

  793. .. rst-class:: classref-method
    794. 

  794. 

  795. |void| **_draw**\ (\ ) |virtual| :ref:`๐Ÿ”—<class_CanvasItem_private_method__draw>`
    796. 

  796. 

  797. Called when **CanvasItem** has been requested to redraw (after :ref:`queue_redraw<class_CanvasItem_method_queue_redraw>` is called, either manually or by the engine).
    798. 

  798. 

  799. Corresponds to the :ref:`NOTIFICATION_DRAW<class_CanvasItem_constant_NOTIFICATION_DRAW>` notification in :ref:`Object._notification<class_Object_private_method__notification>`.
    800. 

  800. 

  801. .. rst-class:: classref-item-separator
    802. 

  802. 

  803. ----
    804. 

  804. 

  805. .. _class_CanvasItem_method_draw_animation_slice:
    806. 

  806. 

  807. .. rst-class:: classref-method
    808. 

  808. 

  809. |void| **draw_animation_slice**\ (\ animation_length\: :ref:`float<class_float>`, slice_begin\: :ref:`float<class_float>`, slice_end\: :ref:`float<class_float>`, offset\: :ref:`float<class_float>` = 0.0\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_animation_slice>`
    810. 

  810. 

  811. Subsequent drawing commands will be ignored unless they fall within the specified animation slice. This is a faster way to implement animations that loop on background rather than redrawing constantly.
    812. 

  812. 

  813. .. rst-class:: classref-item-separator
    814. 

  814. 

  815. ----
    816. 

  816. 

  817. .. _class_CanvasItem_method_draw_arc:
    818. 

  818. 

  819. .. rst-class:: classref-method
    820. 

  820. 

  821. |void| **draw_arc**\ (\ center\: :ref:`Vector2<class_Vector2>`, radius\: :ref:`float<class_float>`, start_angle\: :ref:`float<class_float>`, end_angle\: :ref:`float<class_float>`, point_count\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_arc>`
    822. 

  822. 

  823. Draws an unfilled arc between the given angles with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). The larger the value of ``point_count``, the smoother the curve. See also :ref:`draw_circle<class_CanvasItem_method_draw_circle>`.
    824. 

  824. 

  825. If ``width`` is negative, it will be ignored and the arc will be drawn using :ref:`RenderingServer.PRIMITIVE_LINE_STRIP<class_RenderingServer_constant_PRIMITIVE_LINE_STRIP>`. This means that when the CanvasItem is scaled, the arc will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``.
    826. 

  826. 

  827. The arc is drawn from ``start_angle`` towards the value of ``end_angle`` so in clockwise direction if ``start_angle < end_angle`` and counter-clockwise otherwise. Passing the same angles but in reversed order will produce the same arc. If absolute difference of ``start_angle`` and ``end_angle`` is greater than :ref:`@GDScript.TAU<class_@GDScript_constant_TAU>` radians, then a full circle arc is drawn (i.e. arc will not overlap itself).
    828. 

  828. 

  829. .. rst-class:: classref-item-separator
    830. 

  830. 

  831. ----
    832. 

  832. 

  833. .. _class_CanvasItem_method_draw_char:
    834. 

  834. 

  835. .. rst-class:: classref-method
    836. 

  836. 

  837. |void| **draw_char**\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, char\: :ref:`String<class_String>`, font_size\: :ref:`int<class_int>` = 16, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_draw_char>`
    838. 

  838. 

  839. Draws a string first character using a custom font.
    840. 

  840. 

  841. .. rst-class:: classref-item-separator
    842. 

  842. 

  843. ----
    844. 

  844. 

  845. .. _class_CanvasItem_method_draw_char_outline:
    846. 

  846. 

  847. .. rst-class:: classref-method
    848. 

  848. 

  849. |void| **draw_char_outline**\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, char\: :ref:`String<class_String>`, font_size\: :ref:`int<class_int>` = 16, size\: :ref:`int<class_int>` = -1, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_draw_char_outline>`
    850. 

  850. 

  851. Draws a string first character outline using a custom font.
    852. 

  852. 

  853. .. rst-class:: classref-item-separator
    854. 

  854. 

  855. ----
    856. 

  856. 

  857. .. _class_CanvasItem_method_draw_circle:
    858. 

  858. 

  859. .. rst-class:: classref-method
    860. 

  860. 

  861. |void| **draw_circle**\ (\ position\: :ref:`Vector2<class_Vector2>`, radius\: :ref:`float<class_float>`, color\: :ref:`Color<class_Color>`, filled\: :ref:`bool<class_bool>` = true, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_circle>`
    862. 

  862. 

  863. Draws a circle. See also :ref:`draw_arc<class_CanvasItem_method_draw_arc>`, :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>`, and :ref:`draw_polygon<class_CanvasItem_method_draw_polygon>`.
    864. 

  864. 

  865. If ``filled`` is ``true``, the circle will be filled with the ``color`` specified. If ``filled`` is ``false``, the circle will be drawn as a stroke with the ``color`` and ``width`` specified.
    866. 

  866. 

  867. If ``width`` is negative, then two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the lines will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``.
    868. 

  868. 

  869. If ``antialiased`` is ``true``, half transparent "feathers" will be attached to the boundary, making outlines smooth.
    870. 

  870. 

  871. \ **Note:** ``width`` is only effective if ``filled`` is ``false``.
    872. 

  872. 

  873. .. rst-class:: classref-item-separator
    874. 

  874. 

  875. ----
    876. 

  876. 

  877. .. _class_CanvasItem_method_draw_colored_polygon:
    878. 

  878. 

  879. .. rst-class:: classref-method
    880. 

  880. 

  881. |void| **draw_colored_polygon**\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, color\: :ref:`Color<class_Color>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), texture\: :ref:`Texture2D<class_Texture2D>` = null\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_colored_polygon>`
    882. 

  882. 

  883. Draws a colored polygon of any number of points, convex or concave. Unlike :ref:`draw_polygon<class_CanvasItem_method_draw_polygon>`, a single color must be specified for the whole polygon.
    884. 

  884. 

  885. \ **Note:** If you frequently redraw the same polygon with a large number of vertices, consider pre-calculating the triangulation with :ref:`Geometry2D.triangulate_polygon<class_Geometry2D_method_triangulate_polygon>` and using :ref:`draw_mesh<class_CanvasItem_method_draw_mesh>`, :ref:`draw_multimesh<class_CanvasItem_method_draw_multimesh>`, or :ref:`RenderingServer.canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>`.
    886. 

  886. 

  887. .. rst-class:: classref-item-separator
    888. 

  888. 

  889. ----
    890. 

  890. 

  891. .. _class_CanvasItem_method_draw_dashed_line:
    892. 

  892. 

  893. .. rst-class:: classref-method
    894. 

  894. 

  895. |void| **draw_dashed_line**\ (\ from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, dash\: :ref:`float<class_float>` = 2.0, aligned\: :ref:`bool<class_bool>` = true, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_dashed_line>`
    896. 

  896. 

  897. Draws a dashed line from a 2D point to another, with a given color and width. See also :ref:`draw_multiline<class_CanvasItem_method_draw_multiline>` and :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>`.
    898. 

  898. 

  899. If ``width`` is negative, then a two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the line parts will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``.
    900. 

  900. 

  901. If ``antialiased`` is ``true``, half transparent "feathers" will be attached to the boundary, making outlines smooth.
    902. 

  902. 

  903. \ **Note:** ``antialiased`` is only effective if ``width`` is greater than ``0.0``.
    904. 

  904. 

  905. .. rst-class:: classref-item-separator
    906. 

  906. 

  907. ----
    908. 

  908. 

  909. .. _class_CanvasItem_method_draw_end_animation:
    910. 

  910. 

  911. .. rst-class:: classref-method
    912. 

  912. 

  913. |void| **draw_end_animation**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_end_animation>`
    914. 

  914. 

  915. After submitting all animations slices via :ref:`draw_animation_slice<class_CanvasItem_method_draw_animation_slice>`, this function can be used to revert drawing to its default state (all subsequent drawing commands will be visible). If you don't care about this particular use case, usage of this function after submitting the slices is not required.
    916. 

  916. 

  917. .. rst-class:: classref-item-separator
    918. 

  918. 

  919. ----
    920. 

  920. 

  921. .. _class_CanvasItem_method_draw_lcd_texture_rect_region:
    922. 

  922. 

  923. .. rst-class:: classref-method
    924. 

  924. 

  925. |void| **draw_lcd_texture_rect_region**\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, rect\: :ref:`Rect2<class_Rect2>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_lcd_texture_rect_region>`
    926. 

  926. 

  927. Draws a textured rectangle region of the font texture with LCD subpixel anti-aliasing at a given position, optionally modulated by a color.
    928. 

  928. 

  929. Texture is drawn using the following blend operation, blend mode of the :ref:`CanvasItemMaterial<class_CanvasItemMaterial>` is ignored:
    930. 

  930. 

  931. ::
    932. 

  932. 

  933.     dst.r = texture.r * modulate.r * modulate.a + dst.r * (1.0 - texture.r * modulate.a);
    934. 

  934.     dst.g = texture.g * modulate.g * modulate.a + dst.g * (1.0 - texture.g * modulate.a);
    935. 

  935.     dst.b = texture.b * modulate.b * modulate.a + dst.b * (1.0 - texture.b * modulate.a);
    936. 

  936.     dst.a = modulate.a + dst.a * (1.0 - modulate.a);
    937. 

  937. 

  938. .. rst-class:: classref-item-separator
    939. 

  939. 

  940. ----
    941. 

  941. 

  942. .. _class_CanvasItem_method_draw_line:
    943. 

  943. 

  944. .. rst-class:: classref-method
    945. 

  945. 

  946. |void| **draw_line**\ (\ from\: :ref:`Vector2<class_Vector2>`, to\: :ref:`Vector2<class_Vector2>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_line>`
    947. 

  947. 

  948. Draws a line from a 2D point to another, with a given color and width. It can be optionally antialiased. See also :ref:`draw_multiline<class_CanvasItem_method_draw_multiline>` and :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>`.
    949. 

  949. 

  950. If ``width`` is negative, then a two-point primitive will be drawn instead of a four-point one. This means that when the CanvasItem is scaled, the line will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``.
    951. 

  951. 

  952. .. rst-class:: classref-item-separator
    953. 

  953. 

  954. ----
    955. 

  955. 

  956. .. _class_CanvasItem_method_draw_mesh:
    957. 

  957. 

  958. .. rst-class:: classref-method
    959. 

  959. 

  960. |void| **draw_mesh**\ (\ mesh\: :ref:`Mesh<class_Mesh>`, texture\: :ref:`Texture2D<class_Texture2D>`, transform\: :ref:`Transform2D<class_Transform2D>` = Transform2D(1, 0, 0, 1, 0, 0), modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_mesh>`
    961. 

  961. 

  962. Draws a :ref:`Mesh<class_Mesh>` in 2D, using the provided texture. See :ref:`MeshInstance2D<class_MeshInstance2D>` for related documentation.
    963. 

  963. 

  964. .. rst-class:: classref-item-separator
    965. 

  965. 

  966. ----
    967. 

  967. 

  968. .. _class_CanvasItem_method_draw_msdf_texture_rect_region:
    969. 

  969. 

  970. .. rst-class:: classref-method
    971. 

  971. 

  972. |void| **draw_msdf_texture_rect_region**\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, rect\: :ref:`Rect2<class_Rect2>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), outline\: :ref:`float<class_float>` = 0.0, pixel_range\: :ref:`float<class_float>` = 4.0, scale\: :ref:`float<class_float>` = 1.0\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_msdf_texture_rect_region>`
    973. 

  973. 

  974. Draws a textured rectangle region of the multi-channel signed distance field texture at a given position, optionally modulated by a color. See :ref:`FontFile.multichannel_signed_distance_field<class_FontFile_property_multichannel_signed_distance_field>` for more information and caveats about MSDF font rendering.
    975. 

  975. 

  976. If ``outline`` is positive, each alpha channel value of pixel in region is set to maximum value of true distance in the ``outline`` radius.
    977. 

  977. 

  978. Value of the ``pixel_range`` should the same that was used during distance field texture generation.
    979. 

  979. 

  980. .. rst-class:: classref-item-separator
    981. 

  981. 

  982. ----
    983. 

  983. 

  984. .. _class_CanvasItem_method_draw_multiline:
    985. 

  985. 

  986. .. rst-class:: classref-method
    987. 

  987. 

  988. |void| **draw_multiline**\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_multiline>`
    989. 

  989. 

  990. Draws multiple disconnected lines with a uniform ``width`` and ``color``. Each line is defined by two consecutive points from ``points`` array, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line<class_CanvasItem_method_draw_line>` calls. To draw interconnected lines, use :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>` instead.
    991. 

  991. 

  992. If ``width`` is negative, then two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the lines will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``.
    993. 

  993. 

  994. \ **Note:** ``antialiased`` is only effective if ``width`` is greater than ``0.0``.
    995. 

  995. 

  996. .. rst-class:: classref-item-separator
    997. 

  997. 

  998. ----
    999. 

  999. 

  1000. .. _class_CanvasItem_method_draw_multiline_colors:
    1001. 

  1001. 

  1002. .. rst-class:: classref-method
    1003. 

  1003. 

  1004. |void| **draw_multiline_colors**\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_multiline_colors>`
    1005. 

  1005. 

  1006. Draws multiple disconnected lines with a uniform ``width`` and segment-by-segment coloring. Each segment is defined by two consecutive points from ``points`` array and a corresponding color from ``colors`` array, i.e. i-th segment consists of ``points[2 * i]``, ``points[2 * i + 1]`` endpoints and has ``colors[i]`` color. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line<class_CanvasItem_method_draw_line>` calls. To draw interconnected lines, use :ref:`draw_polyline_colors<class_CanvasItem_method_draw_polyline_colors>` instead.
    1007. 

  1007. 

  1008. If ``width`` is negative, then two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the lines will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``.
    1009. 

  1009. 

  1010. \ **Note:** ``antialiased`` is only effective if ``width`` is greater than ``0.0``.
    1011. 

  1011. 

  1012. .. rst-class:: classref-item-separator
    1013. 

  1013. 

  1014. ----
    1015. 

  1015. 

  1016. .. _class_CanvasItem_method_draw_multiline_string:
    1017. 

  1017. 

  1018. .. rst-class:: classref-method
    1019. 

  1019. 

  1020. |void| **draw_multiline_string**\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, text\: :ref:`String<class_String>`, alignment\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` = 0, width\: :ref:`float<class_float>` = -1, font_size\: :ref:`int<class_int>` = 16, max_lines\: :ref:`int<class_int>` = -1, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_draw_multiline_string>`
    1021. 

  1021. 

  1022. Breaks ``text`` into lines and draws it using the specified ``font`` at the ``pos`` (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
    1023. 

  1023. 

  1024. .. rst-class:: classref-item-separator
    1025. 

  1025. 

  1026. ----
    1027. 

  1027. 

  1028. .. _class_CanvasItem_method_draw_multiline_string_outline:
    1029. 

  1029. 

  1030. .. rst-class:: classref-method
    1031. 

  1031. 

  1032. |void| **draw_multiline_string_outline**\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, text\: :ref:`String<class_String>`, alignment\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` = 0, width\: :ref:`float<class_float>` = -1, font_size\: :ref:`int<class_int>` = 16, max_lines\: :ref:`int<class_int>` = -1, size\: :ref:`int<class_int>` = 1, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), brk_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3, justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_draw_multiline_string_outline>`
    1033. 

  1033. 

  1034. Breaks ``text`` to the lines and draws text outline using the specified ``font`` at the ``pos`` (top-left corner). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
    1035. 

  1035. 

  1036. .. rst-class:: classref-item-separator
    1037. 

  1037. 

  1038. ----
    1039. 

  1039. 

  1040. .. _class_CanvasItem_method_draw_multimesh:
    1041. 

  1041. 

  1042. .. rst-class:: classref-method
    1043. 

  1043. 

  1044. |void| **draw_multimesh**\ (\ multimesh\: :ref:`MultiMesh<class_MultiMesh>`, texture\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_multimesh>`
    1045. 

  1045. 

  1046. Draws a :ref:`MultiMesh<class_MultiMesh>` in 2D with the provided texture. See :ref:`MultiMeshInstance2D<class_MultiMeshInstance2D>` for related documentation.
    1047. 

  1047. 

  1048. .. rst-class:: classref-item-separator
    1049. 

  1049. 

  1050. ----
    1051. 

  1051. 

  1052. .. _class_CanvasItem_method_draw_polygon:
    1053. 

  1053. 

  1054. .. rst-class:: classref-method
    1055. 

  1055. 

  1056. |void| **draw_polygon**\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>` = PackedVector2Array(), texture\: :ref:`Texture2D<class_Texture2D>` = null\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_polygon>`
    1057. 

  1057. 

  1058. Draws a solid polygon of any number of points, convex or concave. Unlike :ref:`draw_colored_polygon<class_CanvasItem_method_draw_colored_polygon>`, each point's color can be changed individually. See also :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>` and :ref:`draw_polyline_colors<class_CanvasItem_method_draw_polyline_colors>`. If you need more flexibility (such as being able to use bones), use :ref:`RenderingServer.canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>` instead.
    1059. 

  1059. 

  1060. \ **Note:** If you frequently redraw the same polygon with a large number of vertices, consider pre-calculating the triangulation with :ref:`Geometry2D.triangulate_polygon<class_Geometry2D_method_triangulate_polygon>` and using :ref:`draw_mesh<class_CanvasItem_method_draw_mesh>`, :ref:`draw_multimesh<class_CanvasItem_method_draw_multimesh>`, or :ref:`RenderingServer.canvas_item_add_triangle_array<class_RenderingServer_method_canvas_item_add_triangle_array>`.
    1061. 

  1061. 

  1062. .. rst-class:: classref-item-separator
    1063. 

  1063. 

  1064. ----
    1065. 

  1065. 

  1066. .. _class_CanvasItem_method_draw_polyline:
    1067. 

  1067. 

  1068. .. rst-class:: classref-method
    1069. 

  1069. 

  1070. |void| **draw_polyline**\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, color\: :ref:`Color<class_Color>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_polyline>`
    1071. 

  1071. 

  1072. Draws interconnected line segments with a uniform ``color`` and ``width`` and optional antialiasing (supported only for positive ``width``). When drawing large amounts of lines, this is faster than using individual :ref:`draw_line<class_CanvasItem_method_draw_line>` calls. To draw disconnected lines, use :ref:`draw_multiline<class_CanvasItem_method_draw_multiline>` instead. See also :ref:`draw_polygon<class_CanvasItem_method_draw_polygon>`.
    1073. 

  1073. 

  1074. If ``width`` is negative, it will be ignored and the polyline will be drawn using :ref:`RenderingServer.PRIMITIVE_LINE_STRIP<class_RenderingServer_constant_PRIMITIVE_LINE_STRIP>`. This means that when the CanvasItem is scaled, the polyline will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``.
    1075. 

  1075. 

  1076. .. rst-class:: classref-item-separator
    1077. 

  1077. 

  1078. ----
    1079. 

  1079. 

  1080. .. _class_CanvasItem_method_draw_polyline_colors:
    1081. 

  1081. 

  1082. .. rst-class:: classref-method
    1083. 

  1083. 

  1084. |void| **draw_polyline_colors**\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_polyline_colors>`
    1085. 

  1085. 

  1086. Draws interconnected line segments with a uniform ``width``, point-by-point coloring, and optional antialiasing (supported only for positive ``width``). Colors assigned to line points match by index between ``points`` and ``colors``, i.e. each line segment is filled with a gradient between the colors of the endpoints. When drawing large amounts of lines, this is faster than using individual :ref:`draw_line<class_CanvasItem_method_draw_line>` calls. To draw disconnected lines, use :ref:`draw_multiline_colors<class_CanvasItem_method_draw_multiline_colors>` instead. See also :ref:`draw_polygon<class_CanvasItem_method_draw_polygon>`.
    1087. 

  1087. 

  1088. If ``width`` is negative, it will be ignored and the polyline will be drawn using :ref:`RenderingServer.PRIMITIVE_LINE_STRIP<class_RenderingServer_constant_PRIMITIVE_LINE_STRIP>`. This means that when the CanvasItem is scaled, the polyline will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``.
    1089. 

  1089. 

  1090. .. rst-class:: classref-item-separator
    1091. 

  1091. 

  1092. ----
    1093. 

  1093. 

  1094. .. _class_CanvasItem_method_draw_primitive:
    1095. 

  1095. 

  1096. .. rst-class:: classref-method
    1097. 

  1097. 

  1098. |void| **draw_primitive**\ (\ points\: :ref:`PackedVector2Array<class_PackedVector2Array>`, colors\: :ref:`PackedColorArray<class_PackedColorArray>`, uvs\: :ref:`PackedVector2Array<class_PackedVector2Array>`, texture\: :ref:`Texture2D<class_Texture2D>` = null\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_primitive>`
    1099. 

  1099. 

  1100. Draws a custom primitive. 1 point for a point, 2 points for a line, 3 points for a triangle, and 4 points for a quad. If 0 points or more than 4 points are specified, nothing will be drawn and an error message will be printed. See also :ref:`draw_line<class_CanvasItem_method_draw_line>`, :ref:`draw_polyline<class_CanvasItem_method_draw_polyline>`, :ref:`draw_polygon<class_CanvasItem_method_draw_polygon>`, and :ref:`draw_rect<class_CanvasItem_method_draw_rect>`.
    1101. 

  1101. 

  1102. .. rst-class:: classref-item-separator
    1103. 

  1103. 

  1104. ----
    1105. 

  1105. 

  1106. .. _class_CanvasItem_method_draw_rect:
    1107. 

  1107. 

  1108. .. rst-class:: classref-method
    1109. 

  1109. 

  1110. |void| **draw_rect**\ (\ rect\: :ref:`Rect2<class_Rect2>`, color\: :ref:`Color<class_Color>`, filled\: :ref:`bool<class_bool>` = true, width\: :ref:`float<class_float>` = -1.0, antialiased\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_rect>`
    1111. 

  1111. 

  1112. Draws a rectangle. If ``filled`` is ``true``, the rectangle will be filled with the ``color`` specified. If ``filled`` is ``false``, the rectangle will be drawn as a stroke with the ``color`` and ``width`` specified. See also :ref:`draw_texture_rect<class_CanvasItem_method_draw_texture_rect>`.
    1113. 

  1113. 

  1114. If ``width`` is negative, then two-point primitives will be drawn instead of a four-point ones. This means that when the CanvasItem is scaled, the lines will remain thin. If this behavior is not desired, then pass a positive ``width`` like ``1.0``.
    1115. 

  1115. 

  1116. If ``antialiased`` is ``true``, half transparent "feathers" will be attached to the boundary, making outlines smooth.
    1117. 

  1117. 

  1118. \ **Note:** ``width`` is only effective if ``filled`` is ``false``.
    1119. 

  1119. 

  1120. \ **Note:** Unfilled rectangles drawn with a negative ``width`` may not display perfectly. For example, corners may be missing or brighter due to overlapping lines (for a translucent ``color``).
    1121. 

  1121. 

  1122. .. rst-class:: classref-item-separator
    1123. 

  1123. 

  1124. ----
    1125. 

  1125. 

  1126. .. _class_CanvasItem_method_draw_set_transform:
    1127. 

  1127. 

  1128. .. rst-class:: classref-method
    1129. 

  1129. 

  1130. |void| **draw_set_transform**\ (\ position\: :ref:`Vector2<class_Vector2>`, rotation\: :ref:`float<class_float>` = 0.0, scale\: :ref:`Vector2<class_Vector2>` = Vector2(1, 1)\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_set_transform>`
    1131. 

  1131. 

  1132. Sets a custom transform for drawing via components. Anything drawn afterwards will be transformed by this.
    1133. 

  1133. 

  1134. \ **Note:** :ref:`FontFile.oversampling<class_FontFile_property_oversampling>` does *not* take ``scale`` into account. This means that scaling up/down will cause bitmap fonts and rasterized (non-MSDF) dynamic fonts to appear blurry or pixelated. To ensure text remains crisp regardless of scale, you can enable MSDF font rendering by enabling :ref:`ProjectSettings.gui/theme/default_font_multichannel_signed_distance_field<class_ProjectSettings_property_gui/theme/default_font_multichannel_signed_distance_field>` (applies to the default project font only), or enabling **Multichannel Signed Distance Field** in the import options of a DynamicFont for custom fonts. On system fonts, :ref:`SystemFont.multichannel_signed_distance_field<class_SystemFont_property_multichannel_signed_distance_field>` can be enabled in the inspector.
    1135. 

  1135. 

  1136. .. rst-class:: classref-item-separator
    1137. 

  1137. 

  1138. ----
    1139. 

  1139. 

  1140. .. _class_CanvasItem_method_draw_set_transform_matrix:
    1141. 

  1141. 

  1142. .. rst-class:: classref-method
    1143. 

  1143. 

  1144. |void| **draw_set_transform_matrix**\ (\ xform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_set_transform_matrix>`
    1145. 

  1145. 

  1146. Sets a custom transform for drawing via matrix. Anything drawn afterwards will be transformed by this.
    1147. 

  1147. 

  1148. .. rst-class:: classref-item-separator
    1149. 

  1149. 

  1150. ----
    1151. 

  1151. 

  1152. .. _class_CanvasItem_method_draw_string:
    1153. 

  1153. 

  1154. .. rst-class:: classref-method
    1155. 

  1155. 

  1156. |void| **draw_string**\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, text\: :ref:`String<class_String>`, alignment\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` = 0, width\: :ref:`float<class_float>` = -1, font_size\: :ref:`int<class_int>` = 16, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_draw_string>`
    1157. 

  1157. 

  1158. Draws ``text`` using the specified ``font`` at the ``pos`` (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
    1159. 

  1159. 

  1160. \ **Example:** Draw "Hello world", using the project's default font:
    1161. 

  1161. 

  1162. 

  1163. .. tabs::
    1164. 

  1164. 

  1165.  .. code-tab:: gdscript
    1166. 

  1166. 

  1167.     # If using this method in a script that redraws constantly, move the
    1168. 

  1168.     # `default_font` declaration to a member variable assigned in `_ready()`
    1169. 

  1169.     # so the Control is only created once.
    1170. 

  1170.     var default_font = ThemeDB.fallback_font
    1171. 

  1171.     var default_font_size = ThemeDB.fallback_font_size
    1172. 

  1172.     draw_string(default_font, Vector2(64, 64), "Hello world", HORIZONTAL_ALIGNMENT_LEFT, -1, default_font_size)
    1173. 

  1173. 

  1174.  .. code-tab:: csharp
    1175. 

  1175. 

  1176.     // If using this method in a script that redraws constantly, move the
    1177. 

  1177.     // `default_font` declaration to a member variable assigned in `_Ready()`
    1178. 

  1178.     // so the Control is only created once.
    1179. 

  1179.     Font defaultFont = ThemeDB.FallbackFont;
    1180. 

  1180.     int defaultFontSize = ThemeDB.FallbackFontSize;
    1181. 

  1181.     DrawString(defaultFont, new Vector2(64, 64), "Hello world", HORIZONTAL_ALIGNMENT_LEFT, -1, defaultFontSize);
    1182. 

  1182. 

  1183. 

  1184. 

  1185. See also :ref:`Font.draw_string<class_Font_method_draw_string>`.
    1186. 

  1186. 

  1187. .. rst-class:: classref-item-separator
    1188. 

  1188. 

  1189. ----
    1190. 

  1190. 

  1191. .. _class_CanvasItem_method_draw_string_outline:
    1192. 

  1192. 

  1193. .. rst-class:: classref-method
    1194. 

  1194. 

  1195. |void| **draw_string_outline**\ (\ font\: :ref:`Font<class_Font>`, pos\: :ref:`Vector2<class_Vector2>`, text\: :ref:`String<class_String>`, alignment\: :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` = 0, width\: :ref:`float<class_float>` = -1, font_size\: :ref:`int<class_int>` = 16, size\: :ref:`int<class_int>` = 1, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_draw_string_outline>`
    1196. 

  1196. 

  1197. Draws ``text`` outline using the specified ``font`` at the ``pos`` (bottom-left corner using the baseline of the font). The text will have its color multiplied by ``modulate``. If ``width`` is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
    1198. 

  1198. 

  1199. .. rst-class:: classref-item-separator
    1200. 

  1200. 

  1201. ----
    1202. 

  1202. 

  1203. .. _class_CanvasItem_method_draw_style_box:
    1204. 

  1204. 

  1205. .. rst-class:: classref-method
    1206. 

  1206. 

  1207. |void| **draw_style_box**\ (\ style_box\: :ref:`StyleBox<class_StyleBox>`, rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_style_box>`
    1208. 

  1208. 

  1209. Draws a styled rectangle.
    1210. 

  1210. 

  1211. .. rst-class:: classref-item-separator
    1212. 

  1212. 

  1213. ----
    1214. 

  1214. 

  1215. .. _class_CanvasItem_method_draw_texture:
    1216. 

  1216. 

  1217. .. rst-class:: classref-method
    1218. 

  1218. 

  1219. |void| **draw_texture**\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, position\: :ref:`Vector2<class_Vector2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_texture>`
    1220. 

  1220. 

  1221. Draws a texture at a given position.
    1222. 

  1222. 

  1223. .. rst-class:: classref-item-separator
    1224. 

  1224. 

  1225. ----
    1226. 

  1226. 

  1227. .. _class_CanvasItem_method_draw_texture_rect:
    1228. 

  1228. 

  1229. .. rst-class:: classref-method
    1230. 

  1230. 

  1231. |void| **draw_texture_rect**\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, rect\: :ref:`Rect2<class_Rect2>`, tile\: :ref:`bool<class_bool>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_texture_rect>`
    1232. 

  1232. 

  1233. Draws a textured rectangle at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_rect<class_CanvasItem_method_draw_rect>` and :ref:`draw_texture_rect_region<class_CanvasItem_method_draw_texture_rect_region>`.
    1234. 

  1234. 

  1235. .. rst-class:: classref-item-separator
    1236. 

  1236. 

  1237. ----
    1238. 

  1238. 

  1239. .. _class_CanvasItem_method_draw_texture_rect_region:
    1240. 

  1240. 

  1241. .. rst-class:: classref-method
    1242. 

  1242. 

  1243. |void| **draw_texture_rect_region**\ (\ texture\: :ref:`Texture2D<class_Texture2D>`, rect\: :ref:`Rect2<class_Rect2>`, src_rect\: :ref:`Rect2<class_Rect2>`, modulate\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1), transpose\: :ref:`bool<class_bool>` = false, clip_uv\: :ref:`bool<class_bool>` = true\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_draw_texture_rect_region>`
    1244. 

  1244. 

  1245. Draws a textured rectangle from a texture's region (specified by ``src_rect``) at a given position, optionally modulated by a color. If ``transpose`` is ``true``, the texture will have its X and Y coordinates swapped. See also :ref:`draw_texture_rect<class_CanvasItem_method_draw_texture_rect>`.
    1246. 

  1246. 

  1247. .. rst-class:: classref-item-separator
    1248. 

  1248. 

  1249. ----
    1250. 

  1250. 

  1251. .. _class_CanvasItem_method_force_update_transform:
    1252. 

  1252. 

  1253. .. rst-class:: classref-method
    1254. 

  1254. 

  1255. |void| **force_update_transform**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_force_update_transform>`
    1256. 

  1256. 

  1257. Forces the transform to update. Transform changes in physics are not instant for performance reasons. Transforms are accumulated and then set. Use this if you need an up-to-date transform when doing physics operations.
    1258. 

  1258. 

  1259. .. rst-class:: classref-item-separator
    1260. 

  1260. 

  1261. ----
    1262. 

  1262. 

  1263. .. _class_CanvasItem_method_get_canvas:
    1264. 

  1264. 

  1265. .. rst-class:: classref-method
    1266. 

  1266. 

  1267. :ref:`RID<class_RID>` **get_canvas**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_canvas>`
    1268. 

  1268. 

  1269. Returns the :ref:`RID<class_RID>` of the :ref:`World2D<class_World2D>` canvas where this item is in.
    1270. 

  1270. 

  1271. .. rst-class:: classref-item-separator
    1272. 

  1272. 

  1273. ----
    1274. 

  1274. 

  1275. .. _class_CanvasItem_method_get_canvas_item:
    1276. 

  1276. 

  1277. .. rst-class:: classref-method
    1278. 

  1278. 

  1279. :ref:`RID<class_RID>` **get_canvas_item**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_canvas_item>`
    1280. 

  1280. 

  1281. Returns the canvas item RID used by :ref:`RenderingServer<class_RenderingServer>` for this item.
    1282. 

  1282. 

  1283. .. rst-class:: classref-item-separator
    1284. 

  1284. 

  1285. ----
    1286. 

  1286. 

  1287. .. _class_CanvasItem_method_get_canvas_layer_node:
    1288. 

  1288. 

  1289. .. rst-class:: classref-method
    1290. 

  1290. 

  1291. :ref:`CanvasLayer<class_CanvasLayer>` **get_canvas_layer_node**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_canvas_layer_node>`
    1292. 

  1292. 

  1293. Returns the :ref:`CanvasLayer<class_CanvasLayer>` that contains this node, or ``null`` if the node is not in any :ref:`CanvasLayer<class_CanvasLayer>`.
    1294. 

  1294. 

  1295. .. rst-class:: classref-item-separator
    1296. 

  1296. 

  1297. ----
    1298. 

  1298. 

  1299. .. _class_CanvasItem_method_get_canvas_transform:
    1300. 

  1300. 

  1301. .. rst-class:: classref-method
    1302. 

  1302. 

  1303. :ref:`Transform2D<class_Transform2D>` **get_canvas_transform**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_canvas_transform>`
    1304. 

  1304. 

  1305. Returns the transform from the coordinate system of the canvas, this item is in, to the :ref:`Viewport<class_Viewport>`\ s coordinate system.
    1306. 

  1306. 

  1307. .. rst-class:: classref-item-separator
    1308. 

  1308. 

  1309. ----
    1310. 

  1310. 

  1311. .. _class_CanvasItem_method_get_global_mouse_position:
    1312. 

  1312. 

  1313. .. rst-class:: classref-method
    1314. 

  1314. 

  1315. :ref:`Vector2<class_Vector2>` **get_global_mouse_position**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_global_mouse_position>`
    1316. 

  1316. 

  1317. Returns the mouse's position in the :ref:`CanvasLayer<class_CanvasLayer>` that this **CanvasItem** is in using the coordinate system of the :ref:`CanvasLayer<class_CanvasLayer>`.
    1318. 

  1318. 

  1319. \ **Note:** For screen-space coordinates (e.g. when using a non-embedded :ref:`Popup<class_Popup>`), you can use :ref:`DisplayServer.mouse_get_position<class_DisplayServer_method_mouse_get_position>`.
    1320. 

  1320. 

  1321. .. rst-class:: classref-item-separator
    1322. 

  1322. 

  1323. ----
    1324. 

  1324. 

  1325. .. _class_CanvasItem_method_get_global_transform:
    1326. 

  1326. 

  1327. .. rst-class:: classref-method
    1328. 

  1328. 

  1329. :ref:`Transform2D<class_Transform2D>` **get_global_transform**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_global_transform>`
    1330. 

  1330. 

  1331. Returns the global transform matrix of this item, i.e. the combined transform up to the topmost **CanvasItem** node. The topmost item is a **CanvasItem** that either has no parent, has non-**CanvasItem** parent or it has :ref:`top_level<class_CanvasItem_property_top_level>` enabled.
    1332. 

  1332. 

  1333. .. rst-class:: classref-item-separator
    1334. 

  1334. 

  1335. ----
    1336. 

  1336. 

  1337. .. _class_CanvasItem_method_get_global_transform_with_canvas:
    1338. 

  1338. 

  1339. .. rst-class:: classref-method
    1340. 

  1340. 

  1341. :ref:`Transform2D<class_Transform2D>` **get_global_transform_with_canvas**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_global_transform_with_canvas>`
    1342. 

  1342. 

  1343. Returns the transform from the local coordinate system of this **CanvasItem** to the :ref:`Viewport<class_Viewport>`\ s coordinate system.
    1344. 

  1344. 

  1345. .. rst-class:: classref-item-separator
    1346. 

  1346. 

  1347. ----
    1348. 

  1348. 

  1349. .. _class_CanvasItem_method_get_local_mouse_position:
    1350. 

  1350. 

  1351. .. rst-class:: classref-method
    1352. 

  1352. 

  1353. :ref:`Vector2<class_Vector2>` **get_local_mouse_position**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_local_mouse_position>`
    1354. 

  1354. 

  1355. Returns the mouse's position in this **CanvasItem** using the local coordinate system of this **CanvasItem**.
    1356. 

  1356. 

  1357. .. rst-class:: classref-item-separator
    1358. 

  1358. 

  1359. ----
    1360. 

  1360. 

  1361. .. _class_CanvasItem_method_get_screen_transform:
    1362. 

  1362. 

  1363. .. rst-class:: classref-method
    1364. 

  1364. 

  1365. :ref:`Transform2D<class_Transform2D>` **get_screen_transform**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_screen_transform>`
    1366. 

  1366. 

  1367. Returns the transform of this **CanvasItem** in global screen coordinates (i.e. taking window position into account). Mostly useful for editor plugins.
    1368. 

  1368. 

  1369. Equals to :ref:`get_global_transform<class_CanvasItem_method_get_global_transform>` if the window is embedded (see :ref:`Viewport.gui_embed_subwindows<class_Viewport_property_gui_embed_subwindows>`).
    1370. 

  1370. 

  1371. .. rst-class:: classref-item-separator
    1372. 

  1372. 

  1373. ----
    1374. 

  1374. 

  1375. .. _class_CanvasItem_method_get_transform:
    1376. 

  1376. 

  1377. .. rst-class:: classref-method
    1378. 

  1378. 

  1379. :ref:`Transform2D<class_Transform2D>` **get_transform**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_transform>`
    1380. 

  1380. 

  1381. Returns the transform matrix of this item.
    1382. 

  1382. 

  1383. .. rst-class:: classref-item-separator
    1384. 

  1384. 

  1385. ----
    1386. 

  1386. 

  1387. .. _class_CanvasItem_method_get_viewport_rect:
    1388. 

  1388. 

  1389. .. rst-class:: classref-method
    1390. 

  1390. 

  1391. :ref:`Rect2<class_Rect2>` **get_viewport_rect**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_viewport_rect>`
    1392. 

  1392. 

  1393. Returns the viewport's boundaries as a :ref:`Rect2<class_Rect2>`.
    1394. 

  1394. 

  1395. .. rst-class:: classref-item-separator
    1396. 

  1396. 

  1397. ----
    1398. 

  1398. 

  1399. .. _class_CanvasItem_method_get_viewport_transform:
    1400. 

  1400. 

  1401. .. rst-class:: classref-method
    1402. 

  1402. 

  1403. :ref:`Transform2D<class_Transform2D>` **get_viewport_transform**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_viewport_transform>`
    1404. 

  1404. 

  1405. Returns the transform from the coordinate system of the canvas, this item is in, to the :ref:`Viewport<class_Viewport>`\ s embedders coordinate system.
    1406. 

  1406. 

  1407. .. rst-class:: classref-item-separator
    1408. 

  1408. 

  1409. ----
    1410. 

  1410. 

  1411. .. _class_CanvasItem_method_get_visibility_layer_bit:
    1412. 

  1412. 

  1413. .. rst-class:: classref-method
    1414. 

  1414. 

  1415. :ref:`bool<class_bool>` **get_visibility_layer_bit**\ (\ layer\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_visibility_layer_bit>`
    1416. 

  1416. 

  1417. Returns an individual bit on the rendering visibility layer.
    1418. 

  1418. 

  1419. .. rst-class:: classref-item-separator
    1420. 

  1420. 

  1421. ----
    1422. 

  1422. 

  1423. .. _class_CanvasItem_method_get_world_2d:
    1424. 

  1424. 

  1425. .. rst-class:: classref-method
    1426. 

  1426. 

  1427. :ref:`World2D<class_World2D>` **get_world_2d**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_get_world_2d>`
    1428. 

  1428. 

  1429. Returns the :ref:`World2D<class_World2D>` where this item is in.
    1430. 

  1430. 

  1431. .. rst-class:: classref-item-separator
    1432. 

  1432. 

  1433. ----
    1434. 

  1434. 

  1435. .. _class_CanvasItem_method_hide:
    1436. 

  1436. 

  1437. .. rst-class:: classref-method
    1438. 

  1438. 

  1439. |void| **hide**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_hide>`
    1440. 

  1440. 

  1441. Hide the **CanvasItem** if it's currently visible. This is equivalent to setting :ref:`visible<class_CanvasItem_property_visible>` to ``false``.
    1442. 

  1442. 

  1443. .. rst-class:: classref-item-separator
    1444. 

  1444. 

  1445. ----
    1446. 

  1446. 

  1447. .. _class_CanvasItem_method_is_local_transform_notification_enabled:
    1448. 

  1448. 

  1449. .. rst-class:: classref-method
    1450. 

  1450. 

  1451. :ref:`bool<class_bool>` **is_local_transform_notification_enabled**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_is_local_transform_notification_enabled>`
    1452. 

  1452. 

  1453. Returns ``true`` if local transform notifications are communicated to children.
    1454. 

  1454. 

  1455. .. rst-class:: classref-item-separator
    1456. 

  1456. 

  1457. ----
    1458. 

  1458. 

  1459. .. _class_CanvasItem_method_is_transform_notification_enabled:
    1460. 

  1460. 

  1461. .. rst-class:: classref-method
    1462. 

  1462. 

  1463. :ref:`bool<class_bool>` **is_transform_notification_enabled**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_is_transform_notification_enabled>`
    1464. 

  1464. 

  1465. Returns ``true`` if global transform notifications are communicated to children.
    1466. 

  1466. 

  1467. .. rst-class:: classref-item-separator
    1468. 

  1468. 

  1469. ----
    1470. 

  1470. 

  1471. .. _class_CanvasItem_method_is_visible_in_tree:
    1472. 

  1472. 

  1473. .. rst-class:: classref-method
    1474. 

  1474. 

  1475. :ref:`bool<class_bool>` **is_visible_in_tree**\ (\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_is_visible_in_tree>`
    1476. 

  1476. 

  1477. Returns ``true`` if the node is present in the :ref:`SceneTree<class_SceneTree>`, its :ref:`visible<class_CanvasItem_property_visible>` property is ``true`` and all its ancestors are also visible. If any ancestor is hidden, this node will not be visible in the scene tree, and is therefore not drawn (see :ref:`_draw<class_CanvasItem_private_method__draw>`).
    1478. 

  1478. 

  1479. Visibility is checked only in parent nodes that inherit from **CanvasItem**, :ref:`CanvasLayer<class_CanvasLayer>`, and :ref:`Window<class_Window>`. If the parent is of any other type (such as :ref:`Node<class_Node>`, :ref:`AnimationPlayer<class_AnimationPlayer>`, or :ref:`Node3D<class_Node3D>`), it is assumed to be visible.
    1480. 

  1480. 

  1481. \ **Note:** This method does not take :ref:`visibility_layer<class_CanvasItem_property_visibility_layer>` into account, so even if this method returns ``true`` the node might end up not being rendered.
    1482. 

  1482. 

  1483. .. rst-class:: classref-item-separator
    1484. 

  1484. 

  1485. ----
    1486. 

  1486. 

  1487. .. _class_CanvasItem_method_make_canvas_position_local:
    1488. 

  1488. 

  1489. .. rst-class:: classref-method
    1490. 

  1490. 

  1491. :ref:`Vector2<class_Vector2>` **make_canvas_position_local**\ (\ viewport_point\: :ref:`Vector2<class_Vector2>`\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_make_canvas_position_local>`
    1492. 

  1492. 

  1493. Transforms ``viewport_point`` from the viewport's coordinates to this node's local coordinates.
    1494. 

  1494. 

  1495. For the opposite operation, use :ref:`get_global_transform_with_canvas<class_CanvasItem_method_get_global_transform_with_canvas>`.
    1496. 

  1496. 

  1497. ::
    1498. 

  1498. 

  1499.     var viewport_point = get_global_transform_with_canvas() * local_point
    1500. 

  1500. 

  1501. .. rst-class:: classref-item-separator
    1502. 

  1502. 

  1503. ----
    1504. 

  1504. 

  1505. .. _class_CanvasItem_method_make_input_local:
    1506. 

  1506. 

  1507. .. rst-class:: classref-method
    1508. 

  1508. 

  1509. :ref:`InputEvent<class_InputEvent>` **make_input_local**\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |const| :ref:`๐Ÿ”—<class_CanvasItem_method_make_input_local>`
    1510. 

  1510. 

  1511. Transformations issued by ``event``'s inputs are applied in local space instead of global space.
    1512. 

  1512. 

  1513. .. rst-class:: classref-item-separator
    1514. 

  1514. 

  1515. ----
    1516. 

  1516. 

  1517. .. _class_CanvasItem_method_move_to_front:
    1518. 

  1518. 

  1519. .. rst-class:: classref-method
    1520. 

  1520. 

  1521. |void| **move_to_front**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_move_to_front>`
    1522. 

  1522. 

  1523. Moves this node to display on top of its siblings.
    1524. 

  1524. 

  1525. Internally, the node is moved to the bottom of parent's child list. The method has no effect on nodes without a parent.
    1526. 

  1526. 

  1527. .. rst-class:: classref-item-separator
    1528. 

  1528. 

  1529. ----
    1530. 

  1530. 

  1531. .. _class_CanvasItem_method_queue_redraw:
    1532. 

  1532. 

  1533. .. rst-class:: classref-method
    1534. 

  1534. 

  1535. |void| **queue_redraw**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_queue_redraw>`
    1536. 

  1536. 

  1537. Queues the **CanvasItem** to redraw. During idle time, if **CanvasItem** is visible, :ref:`NOTIFICATION_DRAW<class_CanvasItem_constant_NOTIFICATION_DRAW>` is sent and :ref:`_draw<class_CanvasItem_private_method__draw>` is called. This only occurs **once** per frame, even if this method has been called multiple times.
    1538. 

  1538. 

  1539. .. rst-class:: classref-item-separator
    1540. 

  1540. 

  1541. ----
    1542. 

  1542. 

  1543. .. _class_CanvasItem_method_set_notify_local_transform:
    1544. 

  1544. 

  1545. .. rst-class:: classref-method
    1546. 

  1546. 

  1547. |void| **set_notify_local_transform**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_set_notify_local_transform>`
    1548. 

  1548. 

  1549. If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED<class_CanvasItem_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED>` when its local transform changes.
    1550. 

  1550. 

  1551. .. rst-class:: classref-item-separator
    1552. 

  1552. 

  1553. ----
    1554. 

  1554. 

  1555. .. _class_CanvasItem_method_set_notify_transform:
    1556. 

  1556. 

  1557. .. rst-class:: classref-method
    1558. 

  1558. 

  1559. |void| **set_notify_transform**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_set_notify_transform>`
    1560. 

  1560. 

  1561. If ``enable`` is ``true``, this node will receive :ref:`NOTIFICATION_TRANSFORM_CHANGED<class_CanvasItem_constant_NOTIFICATION_TRANSFORM_CHANGED>` when its global transform changes.
    1562. 

  1562. 

  1563. .. rst-class:: classref-item-separator
    1564. 

  1564. 

  1565. ----
    1566. 

  1566. 

  1567. .. _class_CanvasItem_method_set_visibility_layer_bit:
    1568. 

  1568. 

  1569. .. rst-class:: classref-method
    1570. 

  1570. 

  1571. |void| **set_visibility_layer_bit**\ (\ layer\: :ref:`int<class_int>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_set_visibility_layer_bit>`
    1572. 

  1572. 

  1573. Set/clear individual bits on the rendering visibility layer. This simplifies editing this **CanvasItem**'s visibility layer.
    1574. 

  1574. 

  1575. .. rst-class:: classref-item-separator
    1576. 

  1576. 

  1577. ----
    1578. 

  1578. 

  1579. .. _class_CanvasItem_method_show:
    1580. 

  1580. 

  1581. .. rst-class:: classref-method
    1582. 

  1582. 

  1583. |void| **show**\ (\ ) :ref:`๐Ÿ”—<class_CanvasItem_method_show>`
    1584. 

  1584. 

  1585. Show the **CanvasItem** if it's currently hidden. This is equivalent to setting :ref:`visible<class_CanvasItem_property_visible>` to ``true``. For controls that inherit :ref:`Popup<class_Popup>`, the correct way to make them visible is to call one of the multiple ``popup*()`` functions instead.
    1586. 

  1586. 

  1587. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    1588. 

  1588. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    1589. 

  1589. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    1590. 

  1590. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    1591. 

  1591. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    1592. 

  1592. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    1593. 

  1593. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    1594. 

  1594. .. |void| replace:: :abbr:`void (No return value.)`
    1595. 

  1595.