首頁 探索 說明
登入
godotengine
/
godot-docs
镜像来自 https://github.com/godotengine/godot-docs
關註 1
讚好 1
複刻 0
檔案
分支: classref/sync-c6d130a
分支列表 標籤列表
godot-docs
/
classes
/
class_canvasitem.rst

class_canvasitem.rst 188 KB
永久連結 文件歷史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650 
  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), oversampling\: :ref:`float<class_float>` = 0.0\ ) |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), oversampling\: :ref:`float<class_float>` = 0.0\ ) |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, oversampling\: :ref:`float<class_float>` = 0.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, oversampling\: :ref:`float<class_float>` = 0.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, oversampling\: :ref:`float<class_float>` = 0.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, oversampling\: :ref:`float<class_float>` = 0.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:`Variant<class_Variant>`         | :ref:`get_instance_shader_parameter<class_CanvasItem_method_get_instance_shader_parameter>`\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
    173. 

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

  174.    | :ref:`Vector2<class_Vector2>`         | :ref:`get_local_mouse_position<class_CanvasItem_method_get_local_mouse_position>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    175. 

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

  176.    | :ref:`Transform2D<class_Transform2D>` | :ref:`get_screen_transform<class_CanvasItem_method_get_screen_transform>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    177. 

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

  178.    | :ref:`Transform2D<class_Transform2D>` | :ref:`get_transform<class_CanvasItem_method_get_transform>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
    179. 

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

  180.    | :ref:`Rect2<class_Rect2>`             | :ref:`get_viewport_rect<class_CanvasItem_method_get_viewport_rect>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    181. 

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

  182.    | :ref:`Transform2D<class_Transform2D>` | :ref:`get_viewport_transform<class_CanvasItem_method_get_viewport_transform>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
    183. 

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

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

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

  186.    | :ref:`World2D<class_World2D>`         | :ref:`get_world_2d<class_CanvasItem_method_get_world_2d>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
    187. 

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

  188.    | |void|                                | :ref:`hide<class_CanvasItem_method_hide>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    189. 

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

  190.    | :ref:`bool<class_bool>`               | :ref:`is_local_transform_notification_enabled<class_CanvasItem_method_is_local_transform_notification_enabled>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
    191. 

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

  192.    | :ref:`bool<class_bool>`               | :ref:`is_transform_notification_enabled<class_CanvasItem_method_is_transform_notification_enabled>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    193. 

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

  194.    | :ref:`bool<class_bool>`               | :ref:`is_visible_in_tree<class_CanvasItem_method_is_visible_in_tree>`\ (\ ) |const|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
    195. 

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

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

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

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

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

  200.    | |void|                                | :ref:`move_to_front<class_CanvasItem_method_move_to_front>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
    201. 

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

  202.    | |void|                                | :ref:`queue_redraw<class_CanvasItem_method_queue_redraw>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    203. 

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

  204.    | |void|                                | :ref:`set_instance_shader_parameter<class_CanvasItem_method_set_instance_shader_parameter>`\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
    205. 

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

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

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

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

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

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

  211.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    212. 

  212.    | |void|                                | :ref:`show<class_CanvasItem_method_show>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
    213. 

  213.    +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    214. 

  214. 

  215. .. rst-class:: classref-section-separator
    216. 

  216. 

  217. ----
    218. 

  218. 

  219. .. rst-class:: classref-descriptions-group
    220. 

  220. 

  221. Signals
    222. 

  222. -------
    223. 

  223. 

  224. .. _class_CanvasItem_signal_draw:
    225. 

  225. 

  226. .. rst-class:: classref-signal
    227. 

  227. 

  228. **draw**\ (\ ) :ref:`🔗<class_CanvasItem_signal_draw>`
    229. 

  229. 

  230. 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.
    231. 

  231. 

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

  233. 

  234. .. rst-class:: classref-item-separator
    235. 

  235. 

  236. ----
    237. 

  237. 

  238. .. _class_CanvasItem_signal_hidden:
    239. 

  239. 

  240. .. rst-class:: classref-signal
    241. 

  241. 

  242. **hidden**\ (\ ) :ref:`🔗<class_CanvasItem_signal_hidden>`
    243. 

  243. 

  244. Emitted when this node becomes hidden, i.e. it's no longer visible in the tree (see :ref:`is_visible_in_tree()<class_CanvasItem_method_is_visible_in_tree>`).
    245. 

  245. 

  246. .. rst-class:: classref-item-separator
    247. 

  247. 

  248. ----
    249. 

  249. 

  250. .. _class_CanvasItem_signal_item_rect_changed:
    251. 

  251. 

  252. .. rst-class:: classref-signal
    253. 

  253. 

  254. **item_rect_changed**\ (\ ) :ref:`🔗<class_CanvasItem_signal_item_rect_changed>`
    255. 

  255. 

  256. 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>`).
    257. 

  257. 

  258. .. rst-class:: classref-item-separator
    259. 

  259. 

  260. ----
    261. 

  261. 

  262. .. _class_CanvasItem_signal_visibility_changed:
    263. 

  263. 

  264. .. rst-class:: classref-signal
    265. 

  265. 

  266. **visibility_changed**\ (\ ) :ref:`🔗<class_CanvasItem_signal_visibility_changed>`
    267. 

  267. 

  268. 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>`).
    269. 

  269. 

  270. This signal is emitted *after* the related :ref:`NOTIFICATION_VISIBILITY_CHANGED<class_CanvasItem_constant_NOTIFICATION_VISIBILITY_CHANGED>` notification.
    271. 

  271. 

  272. .. rst-class:: classref-section-separator
    273. 

  273. 

  274. ----
    275. 

  275. 

  276. .. rst-class:: classref-descriptions-group
    277. 

  277. 

  278. Enumerations
    279. 

  279. ------------
    280. 

  280. 

  281. .. _enum_CanvasItem_TextureFilter:
    282. 

  282. 

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

  284. 

  285. enum **TextureFilter**: :ref:`🔗<enum_CanvasItem_TextureFilter>`
    286. 

  286. 

  287. .. _class_CanvasItem_constant_TEXTURE_FILTER_PARENT_NODE:
    288. 

  288. 

  289. .. rst-class:: classref-enumeration-constant
    290. 

  290. 

  291. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_PARENT_NODE** = ``0``
    292. 

  292. 

  293. The **CanvasItem** will inherit the filter from its parent.
    294. 

  294. 

  295. .. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST:
    296. 

  296. 

  297. .. rst-class:: classref-enumeration-constant
    298. 

  298. 

  299. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_NEAREST** = ``1``
    300. 

  300. 

  301. 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).
    302. 

  302. 

  303. .. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR:
    304. 

  304. 

  305. .. rst-class:: classref-enumeration-constant
    306. 

  306. 

  307. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_LINEAR** = ``2``
    308. 

  308. 

  309. 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).
    310. 

  310. 

  311. .. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS:
    312. 

  312. 

  313. .. rst-class:: classref-enumeration-constant
    314. 

  314. 

  315. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS** = ``3``
    316. 

  316. 

  317. 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.
    318. 

  318. 

  319. 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.
    320. 

  320. 

  321. .. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS:
    322. 

  322. 

  323. .. rst-class:: classref-enumeration-constant
    324. 

  324. 

  325. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS** = ``4``
    326. 

  326. 

  327. 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.
    328. 

  328. 

  329. 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.
    330. 

  330. 

  331. .. _class_CanvasItem_constant_TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC:
    332. 

  332. 

  333. .. rst-class:: classref-enumeration-constant
    334. 

  334. 

  335. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_NEAREST_WITH_MIPMAPS_ANISOTROPIC** = ``5``
    336. 

  336. 

  337. 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>`.
    338. 

  338. 

  339. \ **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.
    340. 

  340. 

  341. .. _class_CanvasItem_constant_TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC:
    342. 

  342. 

  343. .. rst-class:: classref-enumeration-constant
    344. 

  344. 

  345. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_LINEAR_WITH_MIPMAPS_ANISOTROPIC** = ``6``
    346. 

  346. 

  347. 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>`.
    348. 

  348. 

  349. \ **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.
    350. 

  350. 

  351. .. _class_CanvasItem_constant_TEXTURE_FILTER_MAX:
    352. 

  352. 

  353. .. rst-class:: classref-enumeration-constant
    354. 

  354. 

  355. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **TEXTURE_FILTER_MAX** = ``7``
    356. 

  356. 

  357. Represents the size of the :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` enum.
    358. 

  358. 

  359. .. rst-class:: classref-item-separator
    360. 

  360. 

  361. ----
    362. 

  362. 

  363. .. _enum_CanvasItem_TextureRepeat:
    364. 

  364. 

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

  366. 

  367. enum **TextureRepeat**: :ref:`🔗<enum_CanvasItem_TextureRepeat>`
    368. 

  368. 

  369. .. _class_CanvasItem_constant_TEXTURE_REPEAT_PARENT_NODE:
    370. 

  370. 

  371. .. rst-class:: classref-enumeration-constant
    372. 

  372. 

  373. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_PARENT_NODE** = ``0``
    374. 

  374. 

  375. The **CanvasItem** will inherit the filter from its parent.
    376. 

  376. 

  377. .. _class_CanvasItem_constant_TEXTURE_REPEAT_DISABLED:
    378. 

  378. 

  379. .. rst-class:: classref-enumeration-constant
    380. 

  380. 

  381. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_DISABLED** = ``1``
    382. 

  382. 

  383. The texture does not repeat. Sampling the texture outside its extents will result in "stretching" of the edge pixels. You can avoid this by ensuring a 1-pixel fully transparent border on each side of the texture.
    384. 

  384. 

  385. .. _class_CanvasItem_constant_TEXTURE_REPEAT_ENABLED:
    386. 

  386. 

  387. .. rst-class:: classref-enumeration-constant
    388. 

  388. 

  389. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_ENABLED** = ``2``
    390. 

  390. 

  391. The texture repeats when exceeding the texture's size.
    392. 

  392. 

  393. .. _class_CanvasItem_constant_TEXTURE_REPEAT_MIRROR:
    394. 

  394. 

  395. .. rst-class:: classref-enumeration-constant
    396. 

  396. 

  397. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_MIRROR** = ``3``
    398. 

  398. 

  399. The texture repeats when the exceeding the texture's size in a "2×2 tiled mode". Repeated textures at even positions are mirrored.
    400. 

  400. 

  401. .. _class_CanvasItem_constant_TEXTURE_REPEAT_MAX:
    402. 

  402. 

  403. .. rst-class:: classref-enumeration-constant
    404. 

  404. 

  405. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **TEXTURE_REPEAT_MAX** = ``4``
    406. 

  406. 

  407. Represents the size of the :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` enum.
    408. 

  408. 

  409. .. rst-class:: classref-item-separator
    410. 

  410. 

  411. ----
    412. 

  412. 

  413. .. _enum_CanvasItem_ClipChildrenMode:
    414. 

  414. 

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

  416. 

  417. enum **ClipChildrenMode**: :ref:`🔗<enum_CanvasItem_ClipChildrenMode>`
    418. 

  418. 

  419. .. _class_CanvasItem_constant_CLIP_CHILDREN_DISABLED:
    420. 

  420. 

  421. .. rst-class:: classref-enumeration-constant
    422. 

  422. 

  423. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **CLIP_CHILDREN_DISABLED** = ``0``
    424. 

  424. 

  425. Children are drawn over this node and are not clipped.
    426. 

  426. 

  427. .. _class_CanvasItem_constant_CLIP_CHILDREN_ONLY:
    428. 

  428. 

  429. .. rst-class:: classref-enumeration-constant
    430. 

  430. 

  431. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **CLIP_CHILDREN_ONLY** = ``1``
    432. 

  432. 

  433. This node is used as a mask and is **not** drawn. The mask is based on this node's alpha channel: Opaque pixels are kept, transparent pixels are discarded, and semi-transparent pixels are blended in according to their opacity. Children are clipped to this node's drawn area.
    434. 

  434. 

  435. .. _class_CanvasItem_constant_CLIP_CHILDREN_AND_DRAW:
    436. 

  436. 

  437. .. rst-class:: classref-enumeration-constant
    438. 

  438. 

  439. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **CLIP_CHILDREN_AND_DRAW** = ``2``
    440. 

  440. 

  441. This node is used as a mask and is also drawn. The mask is based on this node's alpha channel: Opaque pixels are kept, transparent pixels are discarded, and semi-transparent pixels are blended in according to their opacity. Children are clipped to the parent's drawn area.
    442. 

  442. 

  443. .. _class_CanvasItem_constant_CLIP_CHILDREN_MAX:
    444. 

  444. 

  445. .. rst-class:: classref-enumeration-constant
    446. 

  446. 

  447. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **CLIP_CHILDREN_MAX** = ``3``
    448. 

  448. 

  449. Represents the size of the :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` enum.
    450. 

  450. 

  451. .. rst-class:: classref-section-separator
    452. 

  452. 

  453. ----
    454. 

  454. 

  455. .. rst-class:: classref-descriptions-group
    456. 

  456. 

  457. Constants
    458. 

  458. ---------
    459. 

  459. 

  460. .. _class_CanvasItem_constant_NOTIFICATION_TRANSFORM_CHANGED:
    461. 

  461. 

  462. .. rst-class:: classref-constant
    463. 

  463. 

  464. **NOTIFICATION_TRANSFORM_CHANGED** = ``2000`` :ref:`🔗<class_CanvasItem_constant_NOTIFICATION_TRANSFORM_CHANGED>`
    465. 

  465. 

  466. Notification received when this node's global transform changes, if :ref:`is_transform_notification_enabled()<class_CanvasItem_method_is_transform_notification_enabled>` is ``true``. See also :ref:`set_notify_transform()<class_CanvasItem_method_set_notify_transform>` and :ref:`get_transform()<class_CanvasItem_method_get_transform>`.
    467. 

  467. 

  468. \ **Note:** Many canvas items such as :ref:`Camera2D<class_Camera2D>` or :ref:`CollisionObject2D<class_CollisionObject2D>` automatically enable this in order to function correctly.
    469. 

  469. 

  470. .. _class_CanvasItem_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED:
    471. 

  471. 

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

  473. 

  474. **NOTIFICATION_LOCAL_TRANSFORM_CHANGED** = ``35`` :ref:`🔗<class_CanvasItem_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED>`
    475. 

  475. 

  476. Notification received when this node's transform changes, if :ref:`is_local_transform_notification_enabled()<class_CanvasItem_method_is_local_transform_notification_enabled>` is ``true``. This is not received when a parent :ref:`Node2D<class_Node2D>`'s transform changes. See also :ref:`set_notify_local_transform()<class_CanvasItem_method_set_notify_local_transform>`.
    477. 

  477. 

  478. \ **Note:** Many canvas items such as :ref:`Camera2D<class_Camera2D>` or :ref:`CollisionShape2D<class_CollisionShape2D>` automatically enable this in order to function correctly.
    479. 

  479. 

  480. .. _class_CanvasItem_constant_NOTIFICATION_DRAW:
    481. 

  481. 

  482. .. rst-class:: classref-constant
    483. 

  483. 

  484. **NOTIFICATION_DRAW** = ``30`` :ref:`🔗<class_CanvasItem_constant_NOTIFICATION_DRAW>`
    485. 

  485. 

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

  487. 

  488. .. _class_CanvasItem_constant_NOTIFICATION_VISIBILITY_CHANGED:
    489. 

  489. 

  490. .. rst-class:: classref-constant
    491. 

  491. 

  492. **NOTIFICATION_VISIBILITY_CHANGED** = ``31`` :ref:`🔗<class_CanvasItem_constant_NOTIFICATION_VISIBILITY_CHANGED>`
    493. 

  493. 

  494. Notification received when this node's visibility changes (see :ref:`visible<class_CanvasItem_property_visible>` and :ref:`is_visible_in_tree()<class_CanvasItem_method_is_visible_in_tree>`).
    495. 

  495. 

  496. This notification is received *before* the related :ref:`visibility_changed<class_CanvasItem_signal_visibility_changed>` signal.
    497. 

  497. 

  498. .. _class_CanvasItem_constant_NOTIFICATION_ENTER_CANVAS:
    499. 

  499. 

  500. .. rst-class:: classref-constant
    501. 

  501. 

  502. **NOTIFICATION_ENTER_CANVAS** = ``32`` :ref:`🔗<class_CanvasItem_constant_NOTIFICATION_ENTER_CANVAS>`
    503. 

  503. 

  504. The **CanvasItem** has entered the canvas.
    505. 

  505. 

  506. .. _class_CanvasItem_constant_NOTIFICATION_EXIT_CANVAS:
    507. 

  507. 

  508. .. rst-class:: classref-constant
    509. 

  509. 

  510. **NOTIFICATION_EXIT_CANVAS** = ``33`` :ref:`🔗<class_CanvasItem_constant_NOTIFICATION_EXIT_CANVAS>`
    511. 

  511. 

  512. The **CanvasItem** has exited the canvas.
    513. 

  513. 

  514. .. _class_CanvasItem_constant_NOTIFICATION_WORLD_2D_CHANGED:
    515. 

  515. 

  516. .. rst-class:: classref-constant
    517. 

  517. 

  518. **NOTIFICATION_WORLD_2D_CHANGED** = ``36`` :ref:`🔗<class_CanvasItem_constant_NOTIFICATION_WORLD_2D_CHANGED>`
    519. 

  519. 

  520. Notification received when this **CanvasItem** is registered to a new :ref:`World2D<class_World2D>` (see :ref:`get_world_2d()<class_CanvasItem_method_get_world_2d>`).
    521. 

  521. 

  522. .. rst-class:: classref-section-separator
    523. 

  523. 

  524. ----
    525. 

  525. 

  526. .. rst-class:: classref-descriptions-group
    527. 

  527. 

  528. Property Descriptions
    529. 

  529. ---------------------
    530. 

  530. 

  531. .. _class_CanvasItem_property_clip_children:
    532. 

  532. 

  533. .. rst-class:: classref-property
    534. 

  534. 

  535. :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **clip_children** = ``0`` :ref:`🔗<class_CanvasItem_property_clip_children>`
    536. 

  536. 

  537. .. rst-class:: classref-property-setget
    538. 

  538. 

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

  540. - :ref:`ClipChildrenMode<enum_CanvasItem_ClipChildrenMode>` **get_clip_children_mode**\ (\ )
    541. 

  541. 

  542. The mode in which this node clips its children, acting as a mask.
    543. 

  543. 

  544. \ **Note:** Clipping nodes cannot be nested or placed within a :ref:`CanvasGroup<class_CanvasGroup>`. 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.
    545. 

  545. 

  546. .. rst-class:: classref-item-separator
    547. 

  547. 

  548. ----
    549. 

  549. 

  550. .. _class_CanvasItem_property_light_mask:
    551. 

  551. 

  552. .. rst-class:: classref-property
    553. 

  553. 

  554. :ref:`int<class_int>` **light_mask** = ``1`` :ref:`🔗<class_CanvasItem_property_light_mask>`
    555. 

  555. 

  556. .. rst-class:: classref-property-setget
    557. 

  557. 

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

  559. - :ref:`int<class_int>` **get_light_mask**\ (\ )
    560. 

  560. 

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

  562. 

  563. .. rst-class:: classref-item-separator
    564. 

  564. 

  565. ----
    566. 

  566. 

  567. .. _class_CanvasItem_property_material:
    568. 

  568. 

  569. .. rst-class:: classref-property
    570. 

  570. 

  571. :ref:`Material<class_Material>` **material** :ref:`🔗<class_CanvasItem_property_material>`
    572. 

  572. 

  573. .. rst-class:: classref-property-setget
    574. 

  574. 

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

  576. - :ref:`Material<class_Material>` **get_material**\ (\ )
    577. 

  577. 

  578. The material applied to this **CanvasItem**.
    579. 

  579. 

  580. .. rst-class:: classref-item-separator
    581. 

  581. 

  582. ----
    583. 

  583. 

  584. .. _class_CanvasItem_property_modulate:
    585. 

  585. 

  586. .. rst-class:: classref-property
    587. 

  587. 

  588. :ref:`Color<class_Color>` **modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_CanvasItem_property_modulate>`
    589. 

  589. 

  590. .. rst-class:: classref-property-setget
    591. 

  591. 

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

  593. - :ref:`Color<class_Color>` **get_modulate**\ (\ )
    594. 

  594. 

  595. 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.
    596. 

  596. 

  597. .. rst-class:: classref-item-separator
    598. 

  598. 

  599. ----
    600. 

  600. 

  601. .. _class_CanvasItem_property_self_modulate:
    602. 

  602. 

  603. .. rst-class:: classref-property
    604. 

  604. 

  605. :ref:`Color<class_Color>` **self_modulate** = ``Color(1, 1, 1, 1)`` :ref:`🔗<class_CanvasItem_property_self_modulate>`
    606. 

  606. 

  607. .. rst-class:: classref-property-setget
    608. 

  608. 

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

  610. - :ref:`Color<class_Color>` **get_self_modulate**\ (\ )
    611. 

  611. 

  612. 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.
    613. 

  613. 

  614. \ **Note:** Internal children are also not affected by this property (see the ``include_internal`` parameter in :ref:`Node.add_child()<class_Node_method_add_child>`). For built-in nodes this includes sliders in :ref:`ColorPicker<class_ColorPicker>`, and the tab bar in :ref:`TabContainer<class_TabContainer>`.
    615. 

  615. 

  616. .. rst-class:: classref-item-separator
    617. 

  617. 

  618. ----
    619. 

  619. 

  620. .. _class_CanvasItem_property_show_behind_parent:
    621. 

  621. 

  622. .. rst-class:: classref-property
    623. 

  623. 

  624. :ref:`bool<class_bool>` **show_behind_parent** = ``false`` :ref:`🔗<class_CanvasItem_property_show_behind_parent>`
    625. 

  625. 

  626. .. rst-class:: classref-property-setget
    627. 

  627. 

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

  629. - :ref:`bool<class_bool>` **is_draw_behind_parent_enabled**\ (\ )
    630. 

  630. 

  631. If ``true``, this node draws behind its parent.
    632. 

  632. 

  633. .. rst-class:: classref-item-separator
    634. 

  634. 

  635. ----
    636. 

  636. 

  637. .. _class_CanvasItem_property_texture_filter:
    638. 

  638. 

  639. .. rst-class:: classref-property
    640. 

  640. 

  641. :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **texture_filter** = ``0`` :ref:`🔗<class_CanvasItem_property_texture_filter>`
    642. 

  642. 

  643. .. rst-class:: classref-property-setget
    644. 

  644. 

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

  646. - :ref:`TextureFilter<enum_CanvasItem_TextureFilter>` **get_texture_filter**\ (\ )
    647. 

  647. 

  648. The filtering mode used to render this **CanvasItem**'s texture(s).
    649. 

  649. 

  650. .. rst-class:: classref-item-separator
    651. 

  651. 

  652. ----
    653. 

  653. 

  654. .. _class_CanvasItem_property_texture_repeat:
    655. 

  655. 

  656. .. rst-class:: classref-property
    657. 

  657. 

  658. :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **texture_repeat** = ``0`` :ref:`🔗<class_CanvasItem_property_texture_repeat>`
    659. 

  659. 

  660. .. rst-class:: classref-property-setget
    661. 

  661. 

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

  663. - :ref:`TextureRepeat<enum_CanvasItem_TextureRepeat>` **get_texture_repeat**\ (\ )
    664. 

  664. 

  665. The repeating mode used to render this **CanvasItem**'s texture(s). It affects what happens when the texture is sampled outside its extents, for example by setting a :ref:`Sprite2D.region_rect<class_Sprite2D_property_region_rect>` that is larger than the texture or assigning :ref:`Polygon2D<class_Polygon2D>` UV points outside the texture.
    666. 

  666. 

  667. \ **Note:** :ref:`TextureRect<class_TextureRect>` is not affected by :ref:`texture_repeat<class_CanvasItem_property_texture_repeat>`, as it uses its own texture repeating implementation.
    668. 

  668. 

  669. .. rst-class:: classref-item-separator
    670. 

  670. 

  671. ----
    672. 

  672. 

  673. .. _class_CanvasItem_property_top_level:
    674. 

  674. 

  675. .. rst-class:: classref-property
    676. 

  676. 

  677. :ref:`bool<class_bool>` **top_level** = ``false`` :ref:`🔗<class_CanvasItem_property_top_level>`
    678. 

  678. 

  679. .. rst-class:: classref-property-setget
    680. 

  680. 

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

  682. - :ref:`bool<class_bool>` **is_set_as_top_level**\ (\ )
    683. 

  683. 

  684. 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>`.
    685. 

  685. 

  686. .. rst-class:: classref-item-separator
    687. 

  687. 

  688. ----
    689. 

  689. 

  690. .. _class_CanvasItem_property_use_parent_material:
    691. 

  691. 

  692. .. rst-class:: classref-property
    693. 

  693. 

  694. :ref:`bool<class_bool>` **use_parent_material** = ``false`` :ref:`🔗<class_CanvasItem_property_use_parent_material>`
    695. 

  695. 

  696. .. rst-class:: classref-property-setget
    697. 

  697. 

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

  699. - :ref:`bool<class_bool>` **get_use_parent_material**\ (\ )
    700. 

  700. 

  701. If ``true``, the parent **CanvasItem**'s :ref:`material<class_CanvasItem_property_material>` is used as this node's material.
    702. 

  702. 

  703. .. rst-class:: classref-item-separator
    704. 

  704. 

  705. ----
    706. 

  706. 

  707. .. _class_CanvasItem_property_visibility_layer:
    708. 

  708. 

  709. .. rst-class:: classref-property
    710. 

  710. 

  711. :ref:`int<class_int>` **visibility_layer** = ``1`` :ref:`🔗<class_CanvasItem_property_visibility_layer>`
    712. 

  712. 

  713. .. rst-class:: classref-property-setget
    714. 

  714. 

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

  716. - :ref:`int<class_int>` **get_visibility_layer**\ (\ )
    717. 

  717. 

  718. 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.
    719. 

  719. 

  720. .. rst-class:: classref-item-separator
    721. 

  721. 

  722. ----
    723. 

  723. 

  724. .. _class_CanvasItem_property_visible:
    725. 

  725. 

  726. .. rst-class:: classref-property
    727. 

  727. 

  728. :ref:`bool<class_bool>` **visible** = ``true`` :ref:`🔗<class_CanvasItem_property_visible>`
    729. 

  729. 

  730. .. rst-class:: classref-property-setget
    731. 

  731. 

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

  733. - :ref:`bool<class_bool>` **is_visible**\ (\ )
    734. 

  734. 

  735. 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**.
    736. 

  736. 

  737. \ **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.
    738. 

  738. 

  739. .. rst-class:: classref-item-separator
    740. 

  740. 

  741. ----
    742. 

  742. 

  743. .. _class_CanvasItem_property_y_sort_enabled:
    744. 

  744. 

  745. .. rst-class:: classref-property
    746. 

  746. 

  747. :ref:`bool<class_bool>` **y_sort_enabled** = ``false`` :ref:`🔗<class_CanvasItem_property_y_sort_enabled>`
    748. 

  748. 

  749. .. rst-class:: classref-property-setget
    750. 

  750. 

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

  752. - :ref:`bool<class_bool>` **is_y_sort_enabled**\ (\ )
    753. 

  753. 

  754. 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.
    755. 

  755. 

  756. 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.
    757. 

  757. 

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

  759. 

  760. .. rst-class:: classref-item-separator
    761. 

  761. 

  762. ----
    763. 

  763. 

  764. .. _class_CanvasItem_property_z_as_relative:
    765. 

  765. 

  766. .. rst-class:: classref-property
    767. 

  767. 

  768. :ref:`bool<class_bool>` **z_as_relative** = ``true`` :ref:`🔗<class_CanvasItem_property_z_as_relative>`
    769. 

  769. 

  770. .. rst-class:: classref-property-setget
    771. 

  771. 

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

  773. - :ref:`bool<class_bool>` **is_z_relative**\ (\ )
    774. 

  774. 

  775. If ``true``, this node's final Z index is relative to its parent's Z index.
    776. 

  776. 

  777. For example, if :ref:`z_index<class_CanvasItem_property_z_index>` is ``2`` and its parent's final Z index is ``3``, then this node's final Z index will be ``5`` (``2 + 3``).
    778. 

  778. 

  779. .. rst-class:: classref-item-separator
    780. 

  780. 

  781. ----
    782. 

  782. 

  783. .. _class_CanvasItem_property_z_index:
    784. 

  784. 

  785. .. rst-class:: classref-property
    786. 

  786. 

  787. :ref:`int<class_int>` **z_index** = ``0`` :ref:`🔗<class_CanvasItem_property_z_index>`
    788. 

  788. 

  789. .. rst-class:: classref-property-setget
    790. 

  790. 

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

  792. - :ref:`int<class_int>` **get_z_index**\ (\ )
    793. 

  793. 

  794. The order in which this node is drawn. 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).
    795. 

  795. 

  796. \ **Note:** The Z index does **not** affect the order in which **CanvasItem** nodes are processed or the way input events are handled. This is especially important to keep in mind for :ref:`Control<class_Control>` nodes.
    797. 

  797. 

  798. .. rst-class:: classref-section-separator
    799. 

  799. 

  800. ----
    801. 

  801. 

  802. .. rst-class:: classref-descriptions-group
    803. 

  803. 

  804. Method Descriptions
    805. 

  805. -------------------
    806. 

  806. 

  807. .. _class_CanvasItem_private_method__draw:
    808. 

  808. 

  809. .. rst-class:: classref-method
    810. 

  810. 

  811. |void| **_draw**\ (\ ) |virtual| :ref:`🔗<class_CanvasItem_private_method__draw>`
    812. 

  812. 

  813. 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).
    814. 

  814. 

  815. Corresponds to the :ref:`NOTIFICATION_DRAW<class_CanvasItem_constant_NOTIFICATION_DRAW>` notification in :ref:`Object._notification()<class_Object_private_method__notification>`.
    816. 

  816. 

  817. .. rst-class:: classref-item-separator
    818. 

  818. 

  819. ----
    820. 

  820. 

  821. .. _class_CanvasItem_method_draw_animation_slice:
    822. 

  822. 

  823. .. rst-class:: classref-method
    824. 

  824. 

  825. |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>`
    826. 

  826. 

  827. 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.
    828. 

  828. 

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

  830. 

  831. ----
    832. 

  832. 

  833. .. _class_CanvasItem_method_draw_arc:
    834. 

  834. 

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

  836. 

  837. |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>`
    838. 

  838. 

  839. 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>`.
    840. 

  840. 

  841. 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``.
    842. 

  842. 

  843. 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).
    844. 

  844. 

  845. .. rst-class:: classref-item-separator
    846. 

  846. 

  847. ----
    848. 

  848. 

  849. .. _class_CanvasItem_method_draw_char:
    850. 

  850. 

  851. .. rst-class:: classref-method
    852. 

  852. 

  853. |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), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`🔗<class_CanvasItem_method_draw_char>`
    854. 

  854. 

  855. Draws a string first character using a custom font. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
    856. 

  856. 

  857. .. rst-class:: classref-item-separator
    858. 

  858. 

  859. ----
    860. 

  860. 

  861. .. _class_CanvasItem_method_draw_char_outline:
    862. 

  862. 

  863. .. rst-class:: classref-method
    864. 

  864. 

  865. |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), oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`🔗<class_CanvasItem_method_draw_char_outline>`
    866. 

  866. 

  867. Draws a string first character outline using a custom font. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
    868. 

  868. 

  869. .. rst-class:: classref-item-separator
    870. 

  870. 

  871. ----
    872. 

  872. 

  873. .. _class_CanvasItem_method_draw_circle:
    874. 

  874. 

  875. .. rst-class:: classref-method
    876. 

  876. 

  877. |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>`
    878. 

  878. 

  879. 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>`.
    880. 

  880. 

  881. 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.
    882. 

  882. 

  883. 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``.
    884. 

  884. 

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

  886. 

  887. \ **Note:** ``width`` is only effective if ``filled`` is ``false``.
    888. 

  888. 

  889. .. rst-class:: classref-item-separator
    890. 

  890. 

  891. ----
    892. 

  892. 

  893. .. _class_CanvasItem_method_draw_colored_polygon:
    894. 

  894. 

  895. .. rst-class:: classref-method
    896. 

  896. 

  897. |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>`
    898. 

  898. 

  899. 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.
    900. 

  900. 

  901. \ **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>`.
    902. 

  902. 

  903. .. rst-class:: classref-item-separator
    904. 

  904. 

  905. ----
    906. 

  906. 

  907. .. _class_CanvasItem_method_draw_dashed_line:
    908. 

  908. 

  909. .. rst-class:: classref-method
    910. 

  910. 

  911. |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>`
    912. 

  912. 

  913. Draws a dashed line from a 2D point to another, with a given color and width. See also :ref:`draw_line()<class_CanvasItem_method_draw_line>`, :ref:`draw_multiline()<class_CanvasItem_method_draw_multiline>`, and :ref:`draw_polyline()<class_CanvasItem_method_draw_polyline>`.
    914. 

  914. 

  915. 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``.
    916. 

  916. 

  917. \ ``dash`` is the length of each dash in pixels, with the gap between each dash being the same length. If ``aligned`` is ``true``, the length of the first and last dashes may be shortened or lengthened to allow the line to begin and end at the precise points defined by ``from`` and ``to``. Both ends are always symmetrical when ``aligned`` is ``true``. If ``aligned`` is ``false``, all dashes will have the same length, but the line may appear incomplete at the end due to the dash length not dividing evenly into the line length. Only full dashes are drawn when ``aligned`` is ``false``.
    918. 

  918. 

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

  920. 

  921. \ **Note:** ``antialiased`` is only effective if ``width`` is greater than ``0.0``.
    922. 

  922. 

  923. .. rst-class:: classref-item-separator
    924. 

  924. 

  925. ----
    926. 

  926. 

  927. .. _class_CanvasItem_method_draw_end_animation:
    928. 

  928. 

  929. .. rst-class:: classref-method
    930. 

  930. 

  931. |void| **draw_end_animation**\ (\ ) :ref:`🔗<class_CanvasItem_method_draw_end_animation>`
    932. 

  932. 

  933. 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.
    934. 

  934. 

  935. .. rst-class:: classref-item-separator
    936. 

  936. 

  937. ----
    938. 

  938. 

  939. .. _class_CanvasItem_method_draw_lcd_texture_rect_region:
    940. 

  940. 

  941. .. rst-class:: classref-method
    942. 

  942. 

  943. |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>`
    944. 

  944. 

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

  946. 

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

  948. 

  949. ::
    950. 

  950. 

  951.     dst.r = texture.r * modulate.r * modulate.a + dst.r * (1.0 - texture.r * modulate.a);
    952. 

  952.     dst.g = texture.g * modulate.g * modulate.a + dst.g * (1.0 - texture.g * modulate.a);
    953. 

  953.     dst.b = texture.b * modulate.b * modulate.a + dst.b * (1.0 - texture.b * modulate.a);
    954. 

  954.     dst.a = modulate.a + dst.a * (1.0 - modulate.a);
    955. 

  955. 

  956. .. rst-class:: classref-item-separator
    957. 

  957. 

  958. ----
    959. 

  959. 

  960. .. _class_CanvasItem_method_draw_line:
    961. 

  961. 

  962. .. rst-class:: classref-method
    963. 

  963. 

  964. |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>`
    965. 

  965. 

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

  967. 

  968. 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``.
    969. 

  969. 

  970. .. rst-class:: classref-item-separator
    971. 

  971. 

  972. ----
    973. 

  973. 

  974. .. _class_CanvasItem_method_draw_mesh:
    975. 

  975. 

  976. .. rst-class:: classref-method
    977. 

  977. 

  978. |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>`
    979. 

  979. 

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

  981. 

  982. .. rst-class:: classref-item-separator
    983. 

  983. 

  984. ----
    985. 

  985. 

  986. .. _class_CanvasItem_method_draw_msdf_texture_rect_region:
    987. 

  987. 

  988. .. rst-class:: classref-method
    989. 

  989. 

  990. |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>`
    991. 

  991. 

  992. Draws a textured rectangle region of the multichannel 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.
    993. 

  993. 

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

  995. 

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

  997. 

  998. .. rst-class:: classref-item-separator
    999. 

  999. 

  1000. ----
    1001. 

  1001. 

  1002. .. _class_CanvasItem_method_draw_multiline:
    1003. 

  1003. 

  1004. .. rst-class:: classref-method
    1005. 

  1005. 

  1006. |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>`
    1007. 

  1007. 

  1008. 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.
    1009. 

  1009. 

  1010. 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``.
    1011. 

  1011. 

  1012. \ **Note:** ``antialiased`` is only effective if ``width`` is greater than ``0.0``.
    1013. 

  1013. 

  1014. .. rst-class:: classref-item-separator
    1015. 

  1015. 

  1016. ----
    1017. 

  1017. 

  1018. .. _class_CanvasItem_method_draw_multiline_colors:
    1019. 

  1019. 

  1020. .. rst-class:: classref-method
    1021. 

  1021. 

  1022. |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>`
    1023. 

  1023. 

  1024. 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.
    1025. 

  1025. 

  1026. 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``.
    1027. 

  1027. 

  1028. \ **Note:** ``antialiased`` is only effective if ``width`` is greater than ``0.0``.
    1029. 

  1029. 

  1030. .. rst-class:: classref-item-separator
    1031. 

  1031. 

  1032. ----
    1033. 

  1033. 

  1034. .. _class_CanvasItem_method_draw_multiline_string:
    1035. 

  1035. 

  1036. .. rst-class:: classref-method
    1037. 

  1037. 

  1038. |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, oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`🔗<class_CanvasItem_method_draw_multiline_string>`
    1039. 

  1039. 

  1040. 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. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
    1041. 

  1041. 

  1042. .. rst-class:: classref-item-separator
    1043. 

  1043. 

  1044. ----
    1045. 

  1045. 

  1046. .. _class_CanvasItem_method_draw_multiline_string_outline:
    1047. 

  1047. 

  1048. .. rst-class:: classref-method
    1049. 

  1049. 

  1050. |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, oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`🔗<class_CanvasItem_method_draw_multiline_string_outline>`
    1051. 

  1051. 

  1052. 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. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
    1053. 

  1053. 

  1054. .. rst-class:: classref-item-separator
    1055. 

  1055. 

  1056. ----
    1057. 

  1057. 

  1058. .. _class_CanvasItem_method_draw_multimesh:
    1059. 

  1059. 

  1060. .. rst-class:: classref-method
    1061. 

  1061. 

  1062. |void| **draw_multimesh**\ (\ multimesh\: :ref:`MultiMesh<class_MultiMesh>`, texture\: :ref:`Texture2D<class_Texture2D>`\ ) :ref:`🔗<class_CanvasItem_method_draw_multimesh>`
    1063. 

  1063. 

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

  1065. 

  1066. .. rst-class:: classref-item-separator
    1067. 

  1067. 

  1068. ----
    1069. 

  1069. 

  1070. .. _class_CanvasItem_method_draw_polygon:
    1071. 

  1071. 

  1072. .. rst-class:: classref-method
    1073. 

  1073. 

  1074. |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>`
    1075. 

  1075. 

  1076. 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.
    1077. 

  1077. 

  1078. \ **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>`.
    1079. 

  1079. 

  1080. .. rst-class:: classref-item-separator
    1081. 

  1081. 

  1082. ----
    1083. 

  1083. 

  1084. .. _class_CanvasItem_method_draw_polyline:
    1085. 

  1085. 

  1086. .. rst-class:: classref-method
    1087. 

  1087. 

  1088. |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>`
    1089. 

  1089. 

  1090. 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>`.
    1091. 

  1091. 

  1092. 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``.
    1093. 

  1093. 

  1094. .. rst-class:: classref-item-separator
    1095. 

  1095. 

  1096. ----
    1097. 

  1097. 

  1098. .. _class_CanvasItem_method_draw_polyline_colors:
    1099. 

  1099. 

  1100. .. rst-class:: classref-method
    1101. 

  1101. 

  1102. |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>`
    1103. 

  1103. 

  1104. 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>`.
    1105. 

  1105. 

  1106. 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``.
    1107. 

  1107. 

  1108. .. rst-class:: classref-item-separator
    1109. 

  1109. 

  1110. ----
    1111. 

  1111. 

  1112. .. _class_CanvasItem_method_draw_primitive:
    1113. 

  1113. 

  1114. .. rst-class:: classref-method
    1115. 

  1115. 

  1116. |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>`
    1117. 

  1117. 

  1118. 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>`.
    1119. 

  1119. 

  1120. .. rst-class:: classref-item-separator
    1121. 

  1121. 

  1122. ----
    1123. 

  1123. 

  1124. .. _class_CanvasItem_method_draw_rect:
    1125. 

  1125. 

  1126. .. rst-class:: classref-method
    1127. 

  1127. 

  1128. |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>`
    1129. 

  1129. 

  1130. 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>`.
    1131. 

  1131. 

  1132. 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``.
    1133. 

  1133. 

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

  1135. 

  1136. \ **Note:** ``width`` is only effective if ``filled`` is ``false``.
    1137. 

  1137. 

  1138. \ **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``).
    1139. 

  1139. 

  1140. .. rst-class:: classref-item-separator
    1141. 

  1141. 

  1142. ----
    1143. 

  1143. 

  1144. .. _class_CanvasItem_method_draw_set_transform:
    1145. 

  1145. 

  1146. .. rst-class:: classref-method
    1147. 

  1147. 

  1148. |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>`
    1149. 

  1149. 

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

  1151. 

  1152. \ **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.
    1153. 

  1153. 

  1154. .. rst-class:: classref-item-separator
    1155. 

  1155. 

  1156. ----
    1157. 

  1157. 

  1158. .. _class_CanvasItem_method_draw_set_transform_matrix:
    1159. 

  1159. 

  1160. .. rst-class:: classref-method
    1161. 

  1161. 

  1162. |void| **draw_set_transform_matrix**\ (\ xform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_CanvasItem_method_draw_set_transform_matrix>`
    1163. 

  1163. 

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

  1165. 

  1166. .. rst-class:: classref-item-separator
    1167. 

  1167. 

  1168. ----
    1169. 

  1169. 

  1170. .. _class_CanvasItem_method_draw_string:
    1171. 

  1171. 

  1172. .. rst-class:: classref-method
    1173. 

  1173. 

  1174. |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, oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`🔗<class_CanvasItem_method_draw_string>`
    1175. 

  1175. 

  1176. 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. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
    1177. 

  1177. 

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

  1179. 

  1180. 

  1181. .. tabs::
    1182. 

  1182. 

  1183.  .. code-tab:: gdscript
    1184. 

  1184. 

  1185.     # If using this method in a script that redraws constantly, move the
    1186. 

  1186.     # `default_font` declaration to a member variable assigned in `_ready()`
    1187. 

  1187.     # so the Control is only created once.
    1188. 

  1188.     var default_font = ThemeDB.fallback_font
    1189. 

  1189.     var default_font_size = ThemeDB.fallback_font_size
    1190. 

  1190.     draw_string(default_font, Vector2(64, 64), "Hello world", HORIZONTAL_ALIGNMENT_LEFT, -1, default_font_size)
    1191. 

  1191. 

  1192.  .. code-tab:: csharp
    1193. 

  1193. 

  1194.     // If using this method in a script that redraws constantly, move the
    1195. 

  1195.     // `default_font` declaration to a member variable assigned in `_Ready()`
    1196. 

  1196.     // so the Control is only created once.
    1197. 

  1197.     Font defaultFont = ThemeDB.FallbackFont;
    1198. 

  1198.     int defaultFontSize = ThemeDB.FallbackFontSize;
    1199. 

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

  1200. 

  1201. 

  1202. 

  1203. See also :ref:`Font.draw_string()<class_Font_method_draw_string>`.
    1204. 

  1204. 

  1205. .. rst-class:: classref-item-separator
    1206. 

  1206. 

  1207. ----
    1208. 

  1208. 

  1209. .. _class_CanvasItem_method_draw_string_outline:
    1210. 

  1210. 

  1211. .. rst-class:: classref-method
    1212. 

  1212. 

  1213. |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, oversampling\: :ref:`float<class_float>` = 0.0\ ) |const| :ref:`🔗<class_CanvasItem_method_draw_string_outline>`
    1214. 

  1214. 

  1215. 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. If ``oversampling`` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
    1216. 

  1216. 

  1217. .. rst-class:: classref-item-separator
    1218. 

  1218. 

  1219. ----
    1220. 

  1220. 

  1221. .. _class_CanvasItem_method_draw_style_box:
    1222. 

  1222. 

  1223. .. rst-class:: classref-method
    1224. 

  1224. 

  1225. |void| **draw_style_box**\ (\ style_box\: :ref:`StyleBox<class_StyleBox>`, rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`🔗<class_CanvasItem_method_draw_style_box>`
    1226. 

  1226. 

  1227. Draws a styled rectangle.
    1228. 

  1228. 

  1229. .. rst-class:: classref-item-separator
    1230. 

  1230. 

  1231. ----
    1232. 

  1232. 

  1233. .. _class_CanvasItem_method_draw_texture:
    1234. 

  1234. 

  1235. .. rst-class:: classref-method
    1236. 

  1236. 

  1237. |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>`
    1238. 

  1238. 

  1239. Draws a texture at a given position.
    1240. 

  1240. 

  1241. .. rst-class:: classref-item-separator
    1242. 

  1242. 

  1243. ----
    1244. 

  1244. 

  1245. .. _class_CanvasItem_method_draw_texture_rect:
    1246. 

  1246. 

  1247. .. rst-class:: classref-method
    1248. 

  1248. 

  1249. |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>`
    1250. 

  1250. 

  1251. 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>`.
    1252. 

  1252. 

  1253. .. rst-class:: classref-item-separator
    1254. 

  1254. 

  1255. ----
    1256. 

  1256. 

  1257. .. _class_CanvasItem_method_draw_texture_rect_region:
    1258. 

  1258. 

  1259. .. rst-class:: classref-method
    1260. 

  1260. 

  1261. |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>`
    1262. 

  1262. 

  1263. 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>`.
    1264. 

  1264. 

  1265. .. rst-class:: classref-item-separator
    1266. 

  1266. 

  1267. ----
    1268. 

  1268. 

  1269. .. _class_CanvasItem_method_force_update_transform:
    1270. 

  1270. 

  1271. .. rst-class:: classref-method
    1272. 

  1272. 

  1273. |void| **force_update_transform**\ (\ ) :ref:`🔗<class_CanvasItem_method_force_update_transform>`
    1274. 

  1274. 

  1275. Forces the node's transform to update. Fails if the node is not inside the tree. See also :ref:`get_transform()<class_CanvasItem_method_get_transform>`.
    1276. 

  1276. 

  1277. \ **Note:** For performance reasons, transform changes are usually accumulated and applied *once* at the end of the frame. The update propagates through **CanvasItem** children, as well. Therefore, use this method only when you need an up-to-date transform (such as during physics operations).
    1278. 

  1278. 

  1279. .. rst-class:: classref-item-separator
    1280. 

  1280. 

  1281. ----
    1282. 

  1282. 

  1283. .. _class_CanvasItem_method_get_canvas:
    1284. 

  1284. 

  1285. .. rst-class:: classref-method
    1286. 

  1286. 

  1287. :ref:`RID<class_RID>` **get_canvas**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_canvas>`
    1288. 

  1288. 

  1289. Returns the :ref:`RID<class_RID>` of the :ref:`World2D<class_World2D>` canvas where this node is registered to, used by the :ref:`RenderingServer<class_RenderingServer>`.
    1290. 

  1290. 

  1291. .. rst-class:: classref-item-separator
    1292. 

  1292. 

  1293. ----
    1294. 

  1294. 

  1295. .. _class_CanvasItem_method_get_canvas_item:
    1296. 

  1296. 

  1297. .. rst-class:: classref-method
    1298. 

  1298. 

  1299. :ref:`RID<class_RID>` **get_canvas_item**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_canvas_item>`
    1300. 

  1300. 

  1301. Returns the internal canvas item :ref:`RID<class_RID>` used by the :ref:`RenderingServer<class_RenderingServer>` for this node.
    1302. 

  1302. 

  1303. .. rst-class:: classref-item-separator
    1304. 

  1304. 

  1305. ----
    1306. 

  1306. 

  1307. .. _class_CanvasItem_method_get_canvas_layer_node:
    1308. 

  1308. 

  1309. .. rst-class:: classref-method
    1310. 

  1310. 

  1311. :ref:`CanvasLayer<class_CanvasLayer>` **get_canvas_layer_node**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_canvas_layer_node>`
    1312. 

  1312. 

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

  1314. 

  1315. .. rst-class:: classref-item-separator
    1316. 

  1316. 

  1317. ----
    1318. 

  1318. 

  1319. .. _class_CanvasItem_method_get_canvas_transform:
    1320. 

  1320. 

  1321. .. rst-class:: classref-method
    1322. 

  1322. 

  1323. :ref:`Transform2D<class_Transform2D>` **get_canvas_transform**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_canvas_transform>`
    1324. 

  1324. 

  1325. Returns the transform of this node, converted from its registered canvas's coordinate system to its viewport's coordinate system. See also :ref:`Node.get_viewport()<class_Node_method_get_viewport>`.
    1326. 

  1326. 

  1327. .. rst-class:: classref-item-separator
    1328. 

  1328. 

  1329. ----
    1330. 

  1330. 

  1331. .. _class_CanvasItem_method_get_global_mouse_position:
    1332. 

  1332. 

  1333. .. rst-class:: classref-method
    1334. 

  1334. 

  1335. :ref:`Vector2<class_Vector2>` **get_global_mouse_position**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_global_mouse_position>`
    1336. 

  1336. 

  1337. Returns mouse cursor's global position relative to the :ref:`CanvasLayer<class_CanvasLayer>` that contains this node.
    1338. 

  1338. 

  1339. \ **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>`.
    1340. 

  1340. 

  1341. .. rst-class:: classref-item-separator
    1342. 

  1342. 

  1343. ----
    1344. 

  1344. 

  1345. .. _class_CanvasItem_method_get_global_transform:
    1346. 

  1346. 

  1347. .. rst-class:: classref-method
    1348. 

  1348. 

  1349. :ref:`Transform2D<class_Transform2D>` **get_global_transform**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_global_transform>`
    1350. 

  1350. 

  1351. 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.
    1352. 

  1352. 

  1353. .. rst-class:: classref-item-separator
    1354. 

  1354. 

  1355. ----
    1356. 

  1356. 

  1357. .. _class_CanvasItem_method_get_global_transform_with_canvas:
    1358. 

  1358. 

  1359. .. rst-class:: classref-method
    1360. 

  1360. 

  1361. :ref:`Transform2D<class_Transform2D>` **get_global_transform_with_canvas**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_global_transform_with_canvas>`
    1362. 

  1362. 

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

  1364. 

  1365. .. rst-class:: classref-item-separator
    1366. 

  1366. 

  1367. ----
    1368. 

  1368. 

  1369. .. _class_CanvasItem_method_get_instance_shader_parameter:
    1370. 

  1370. 

  1371. .. rst-class:: classref-method
    1372. 

  1372. 

  1373. :ref:`Variant<class_Variant>` **get_instance_shader_parameter**\ (\ name\: :ref:`StringName<class_StringName>`\ ) |const| :ref:`🔗<class_CanvasItem_method_get_instance_shader_parameter>`
    1374. 

  1374. 

  1375. Get the value of a shader parameter as set on this instance.
    1376. 

  1376. 

  1377. .. rst-class:: classref-item-separator
    1378. 

  1378. 

  1379. ----
    1380. 

  1380. 

  1381. .. _class_CanvasItem_method_get_local_mouse_position:
    1382. 

  1382. 

  1383. .. rst-class:: classref-method
    1384. 

  1384. 

  1385. :ref:`Vector2<class_Vector2>` **get_local_mouse_position**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_local_mouse_position>`
    1386. 

  1386. 

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

  1388. 

  1389. .. rst-class:: classref-item-separator
    1390. 

  1390. 

  1391. ----
    1392. 

  1392. 

  1393. .. _class_CanvasItem_method_get_screen_transform:
    1394. 

  1394. 

  1395. .. rst-class:: classref-method
    1396. 

  1396. 

  1397. :ref:`Transform2D<class_Transform2D>` **get_screen_transform**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_screen_transform>`
    1398. 

  1398. 

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

  1400. 

  1401. 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>`).
    1402. 

  1402. 

  1403. .. rst-class:: classref-item-separator
    1404. 

  1404. 

  1405. ----
    1406. 

  1406. 

  1407. .. _class_CanvasItem_method_get_transform:
    1408. 

  1408. 

  1409. .. rst-class:: classref-method
    1410. 

  1410. 

  1411. :ref:`Transform2D<class_Transform2D>` **get_transform**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_transform>`
    1412. 

  1412. 

  1413. Returns the transform matrix of this **CanvasItem**.
    1414. 

  1414. 

  1415. .. rst-class:: classref-item-separator
    1416. 

  1416. 

  1417. ----
    1418. 

  1418. 

  1419. .. _class_CanvasItem_method_get_viewport_rect:
    1420. 

  1420. 

  1421. .. rst-class:: classref-method
    1422. 

  1422. 

  1423. :ref:`Rect2<class_Rect2>` **get_viewport_rect**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_viewport_rect>`
    1424. 

  1424. 

  1425. Returns this node's viewport boundaries as a :ref:`Rect2<class_Rect2>`. See also :ref:`Node.get_viewport()<class_Node_method_get_viewport>`.
    1426. 

  1426. 

  1427. .. rst-class:: classref-item-separator
    1428. 

  1428. 

  1429. ----
    1430. 

  1430. 

  1431. .. _class_CanvasItem_method_get_viewport_transform:
    1432. 

  1432. 

  1433. .. rst-class:: classref-method
    1434. 

  1434. 

  1435. :ref:`Transform2D<class_Transform2D>` **get_viewport_transform**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_viewport_transform>`
    1436. 

  1436. 

  1437. Returns the transform of this node, converted from its registered canvas's coordinate system to its viewport embedder's coordinate system. See also :ref:`Viewport.get_final_transform()<class_Viewport_method_get_final_transform>` and :ref:`Node.get_viewport()<class_Node_method_get_viewport>`.
    1438. 

  1438. 

  1439. .. rst-class:: classref-item-separator
    1440. 

  1440. 

  1441. ----
    1442. 

  1442. 

  1443. .. _class_CanvasItem_method_get_visibility_layer_bit:
    1444. 

  1444. 

  1445. .. rst-class:: classref-method
    1446. 

  1446. 

  1447. :ref:`bool<class_bool>` **get_visibility_layer_bit**\ (\ layer\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_CanvasItem_method_get_visibility_layer_bit>`
    1448. 

  1448. 

  1449. Returns ``true`` if the layer at the given index is set in :ref:`visibility_layer<class_CanvasItem_property_visibility_layer>`.
    1450. 

  1450. 

  1451. .. rst-class:: classref-item-separator
    1452. 

  1452. 

  1453. ----
    1454. 

  1454. 

  1455. .. _class_CanvasItem_method_get_world_2d:
    1456. 

  1456. 

  1457. .. rst-class:: classref-method
    1458. 

  1458. 

  1459. :ref:`World2D<class_World2D>` **get_world_2d**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_get_world_2d>`
    1460. 

  1460. 

  1461. Returns the :ref:`World2D<class_World2D>` this node is registered to.
    1462. 

  1462. 

  1463. Usually, this is the same as this node's viewport (see :ref:`Node.get_viewport()<class_Node_method_get_viewport>` and :ref:`Viewport.find_world_2d()<class_Viewport_method_find_world_2d>`).
    1464. 

  1464. 

  1465. .. rst-class:: classref-item-separator
    1466. 

  1466. 

  1467. ----
    1468. 

  1468. 

  1469. .. _class_CanvasItem_method_hide:
    1470. 

  1470. 

  1471. .. rst-class:: classref-method
    1472. 

  1472. 

  1473. |void| **hide**\ (\ ) :ref:`🔗<class_CanvasItem_method_hide>`
    1474. 

  1474. 

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

  1476. 

  1477. .. rst-class:: classref-item-separator
    1478. 

  1478. 

  1479. ----
    1480. 

  1480. 

  1481. .. _class_CanvasItem_method_is_local_transform_notification_enabled:
    1482. 

  1482. 

  1483. .. rst-class:: classref-method
    1484. 

  1484. 

  1485. :ref:`bool<class_bool>` **is_local_transform_notification_enabled**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_is_local_transform_notification_enabled>`
    1486. 

  1486. 

  1487. Returns ``true`` if the node receives :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED<class_CanvasItem_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED>` whenever its local transform changes. This is enabled with :ref:`set_notify_local_transform()<class_CanvasItem_method_set_notify_local_transform>`.
    1488. 

  1488. 

  1489. .. rst-class:: classref-item-separator
    1490. 

  1490. 

  1491. ----
    1492. 

  1492. 

  1493. .. _class_CanvasItem_method_is_transform_notification_enabled:
    1494. 

  1494. 

  1495. .. rst-class:: classref-method
    1496. 

  1496. 

  1497. :ref:`bool<class_bool>` **is_transform_notification_enabled**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_is_transform_notification_enabled>`
    1498. 

  1498. 

  1499. Returns ``true`` if the node receives :ref:`NOTIFICATION_TRANSFORM_CHANGED<class_CanvasItem_constant_NOTIFICATION_TRANSFORM_CHANGED>` whenever its global transform changes. This is enabled with :ref:`set_notify_transform()<class_CanvasItem_method_set_notify_transform>`.
    1500. 

  1500. 

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

  1502. 

  1503. ----
    1504. 

  1504. 

  1505. .. _class_CanvasItem_method_is_visible_in_tree:
    1506. 

  1506. 

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

  1508. 

  1509. :ref:`bool<class_bool>` **is_visible_in_tree**\ (\ ) |const| :ref:`🔗<class_CanvasItem_method_is_visible_in_tree>`
    1510. 

  1510. 

  1511. 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>`).
    1512. 

  1512. 

  1513. 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.
    1514. 

  1514. 

  1515. \ **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.
    1516. 

  1516. 

  1517. .. rst-class:: classref-item-separator
    1518. 

  1518. 

  1519. ----
    1520. 

  1520. 

  1521. .. _class_CanvasItem_method_make_canvas_position_local:
    1522. 

  1522. 

  1523. .. rst-class:: classref-method
    1524. 

  1524. 

  1525. :ref:`Vector2<class_Vector2>` **make_canvas_position_local**\ (\ viewport_point\: :ref:`Vector2<class_Vector2>`\ ) |const| :ref:`🔗<class_CanvasItem_method_make_canvas_position_local>`
    1526. 

  1526. 

  1527. Transforms ``viewport_point`` from the viewport's coordinates to this node's local coordinates.
    1528. 

  1528. 

  1529. For the opposite operation, use :ref:`get_global_transform_with_canvas()<class_CanvasItem_method_get_global_transform_with_canvas>`.
    1530. 

  1530. 

  1531. ::
    1532. 

  1532. 

  1533.     var viewport_point = get_global_transform_with_canvas() * local_point
    1534. 

  1534. 

  1535. .. rst-class:: classref-item-separator
    1536. 

  1536. 

  1537. ----
    1538. 

  1538. 

  1539. .. _class_CanvasItem_method_make_input_local:
    1540. 

  1540. 

  1541. .. rst-class:: classref-method
    1542. 

  1542. 

  1543. :ref:`InputEvent<class_InputEvent>` **make_input_local**\ (\ event\: :ref:`InputEvent<class_InputEvent>`\ ) |const| :ref:`🔗<class_CanvasItem_method_make_input_local>`
    1544. 

  1544. 

  1545. Returns a copy of the given ``event`` with its coordinates converted from global space to this **CanvasItem**'s local space. If not possible, returns the same :ref:`InputEvent<class_InputEvent>` unchanged.
    1546. 

  1546. 

  1547. .. rst-class:: classref-item-separator
    1548. 

  1548. 

  1549. ----
    1550. 

  1550. 

  1551. .. _class_CanvasItem_method_move_to_front:
    1552. 

  1552. 

  1553. .. rst-class:: classref-method
    1554. 

  1554. 

  1555. |void| **move_to_front**\ (\ ) :ref:`🔗<class_CanvasItem_method_move_to_front>`
    1556. 

  1556. 

  1557. Moves this node below its siblings, usually causing the node to draw on top of its siblings. Does nothing if this node does not have a parent. See also :ref:`Node.move_child()<class_Node_method_move_child>`.
    1558. 

  1558. 

  1559. .. rst-class:: classref-item-separator
    1560. 

  1560. 

  1561. ----
    1562. 

  1562. 

  1563. .. _class_CanvasItem_method_queue_redraw:
    1564. 

  1564. 

  1565. .. rst-class:: classref-method
    1566. 

  1566. 

  1567. |void| **queue_redraw**\ (\ ) :ref:`🔗<class_CanvasItem_method_queue_redraw>`
    1568. 

  1568. 

  1569. 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.
    1570. 

  1570. 

  1571. .. rst-class:: classref-item-separator
    1572. 

  1572. 

  1573. ----
    1574. 

  1574. 

  1575. .. _class_CanvasItem_method_set_instance_shader_parameter:
    1576. 

  1576. 

  1577. .. rst-class:: classref-method
    1578. 

  1578. 

  1579. |void| **set_instance_shader_parameter**\ (\ name\: :ref:`StringName<class_StringName>`, value\: :ref:`Variant<class_Variant>`\ ) :ref:`🔗<class_CanvasItem_method_set_instance_shader_parameter>`
    1580. 

  1580. 

  1581. Set the value of a shader uniform for this instance only (`per-instance uniform <../tutorials/shaders/shader_reference/shading_language.html#per-instance-uniforms>`__). See also :ref:`ShaderMaterial.set_shader_parameter()<class_ShaderMaterial_method_set_shader_parameter>` to assign a uniform on all instances using the same :ref:`ShaderMaterial<class_ShaderMaterial>`.
    1582. 

  1582. 

  1583. \ **Note:** For a shader uniform to be assignable on a per-instance basis, it *must* be defined with ``instance uniform ...`` rather than ``uniform ...`` in the shader code.
    1584. 

  1584. 

  1585. \ **Note:** ``name`` is case-sensitive and must match the name of the uniform in the code exactly (not the capitalized name in the inspector).
    1586. 

  1586. 

  1587. .. rst-class:: classref-item-separator
    1588. 

  1588. 

  1589. ----
    1590. 

  1590. 

  1591. .. _class_CanvasItem_method_set_notify_local_transform:
    1592. 

  1592. 

  1593. .. rst-class:: classref-method
    1594. 

  1594. 

  1595. |void| **set_notify_local_transform**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CanvasItem_method_set_notify_local_transform>`
    1596. 

  1596. 

  1597. If ``true``, the node will receive :ref:`NOTIFICATION_LOCAL_TRANSFORM_CHANGED<class_CanvasItem_constant_NOTIFICATION_LOCAL_TRANSFORM_CHANGED>` whenever its local transform changes.
    1598. 

  1598. 

  1599. \ **Note:** Many canvas items such as :ref:`Bone2D<class_Bone2D>` or :ref:`CollisionShape2D<class_CollisionShape2D>` automatically enable this in order to function correctly.
    1600. 

  1600. 

  1601. .. rst-class:: classref-item-separator
    1602. 

  1602. 

  1603. ----
    1604. 

  1604. 

  1605. .. _class_CanvasItem_method_set_notify_transform:
    1606. 

  1606. 

  1607. .. rst-class:: classref-method
    1608. 

  1608. 

  1609. |void| **set_notify_transform**\ (\ enable\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CanvasItem_method_set_notify_transform>`
    1610. 

  1610. 

  1611. If ``true``, the node will receive :ref:`NOTIFICATION_TRANSFORM_CHANGED<class_CanvasItem_constant_NOTIFICATION_TRANSFORM_CHANGED>` whenever global transform changes.
    1612. 

  1612. 

  1613. \ **Note:** Many canvas items such as :ref:`Camera2D<class_Camera2D>` or :ref:`Light2D<class_Light2D>` automatically enable this in order to function correctly.
    1614. 

  1614. 

  1615. .. rst-class:: classref-item-separator
    1616. 

  1616. 

  1617. ----
    1618. 

  1618. 

  1619. .. _class_CanvasItem_method_set_visibility_layer_bit:
    1620. 

  1620. 

  1621. .. rst-class:: classref-method
    1622. 

  1622. 

  1623. |void| **set_visibility_layer_bit**\ (\ layer\: :ref:`int<class_int>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_CanvasItem_method_set_visibility_layer_bit>`
    1624. 

  1624. 

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

  1626. 

  1627. .. rst-class:: classref-item-separator
    1628. 

  1628. 

  1629. ----
    1630. 

  1630. 

  1631. .. _class_CanvasItem_method_show:
    1632. 

  1632. 

  1633. .. rst-class:: classref-method
    1634. 

  1634. 

  1635. |void| **show**\ (\ ) :ref:`🔗<class_CanvasItem_method_show>`
    1636. 

  1636. 

  1637. Show the **CanvasItem** if it's currently hidden. This is equivalent to setting :ref:`visible<class_CanvasItem_property_visible>` to ``true``.
    1638. 

  1638. 

  1639. \ **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.
    1640. 

  1640. 

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

  1642. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
    1643. 

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

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

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

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

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

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

  1649. .. |void| replace:: :abbr:`void (No return value.)`
    1650. 

  1650.