Custom drawing in 2D

Introduction

Godot has nodes to draw sprites, polygons, particles, and all sorts of stuff. For most cases, this is enough; but not always. Before crying in fear, angst, and rage because a node to draw that specific something does not exist… it would be good to know that it is possible to easily make any 2D node (be it Control or Node2D based) draw custom commands. It is really easy to do it, too.

Custom drawing in a 2D node is really useful. Here are some use cases:

  • Drawing shapes or logic that existing nodes can’t do, such as an image with trails or a special animated polygon.

  • Visualizations that are not that compatible with nodes, such as a tetris board. (The tetris example uses a custom draw function to draw the blocks.)

  • Drawing a large number of simple objects. Custom drawing avoids the overhead of using a large number of nodes, possibly lowering memory usage and improving performance.

  • Making a custom UI control. There are plenty of controls available, but when you have unusual needs, you will likely need a custom control.

Drawing

Add a script to any CanvasItem derived node, like Control or Node2D. Then override the _draw() function.

GDScript

C#

  1. extends Node2D
  3. func _draw():
  4.     # Your draw commands here
  5.     pass
  1. public override void _Draw()
  2. {
  3.     // Your draw commands here
  4. }

Draw commands are described in the CanvasItem class reference. There are plenty of them.

Updating

The _draw() function is only called once, and then the draw commands are cached and remembered, so further calls are unnecessary.

If re-drawing is required because a state or something else changed, call CanvasItem.update() in that same node and a new _draw() call will happen.

Here is a little more complex example, a texture variable that will be redrawn if modified:

GDScript

C#

  1. extends Node2D
  3. export (Texture) var texture setget _set_texture
  5. func _set_texture(value):
  6.     # If the texture variable is modified externally,
  7.     # this callback is called.
  8.     texture = value  # Texture was changed.
  9.     update()  # Update the node's visual representation.
  11. func _draw():
  12.     draw_texture(texture, Vector2())
  1. public class CustomNode2D : Node2D
  2. {
  3.     private Texture _texture;
  4.     public Texture Texture
  5.     {
  6.         get
  7.         {
  8.             return _texture;
  9.         }
  11.         set
  12.         {
  13.             _texture = value;
  14.             Update();
  15.         }
  16.     }
  18.     public override void _Draw()
  19.     {
  20.         DrawTexture(_texture, new Vector2());
  21.     }
  22. }

In some cases, it may be desired to draw every frame. For this, just call update() from the _process() callback, like this:

GDScript

C#

  1. extends Node2D
  3. func _draw():
  4.     # Your draw commands here
  5.     pass
  7. func _process(delta):
  8.     update()
  1. public class CustomNode2D : Node2D
  2. {
  3.     public override void _Draw()
  4.     {
  5.         // Your draw commands here
  6.     }
  8.     public override void _Process(float delta)
  9.     {
  10.         Update();
  11.     }
  12. }

An example: drawing circular arcs

We will now use the custom drawing functionality of the Godot Engine to draw something that Godot doesn’t provide functions for. As an example, Godot provides a draw_circle() function that draws a whole circle. However, what about drawing a portion of a circle? You will have to code a function to perform this and draw it yourself.

Arc function

An arc is defined by its support circle parameters, that is, the center position and the radius. The arc itself is then defined by the angle it starts from and the angle at which it stops. These are the 4 arguments that we have to provide to our drawing function. We’ll also provide the color value, so we can draw the arc in different colors if we wish.

Basically, drawing a shape on the screen requires it to be decomposed into a certain number of points linked from one to the next. As you can imagine, the more points your shape is made of, the smoother it will appear, but the heavier it will also be in terms of processing cost. In general, if your shape is huge (or in 3D, close to the camera), it will require more points to be drawn without it being angular-looking. On the contrary, if your shape is small (or in 3D, far from the camera), you may decrease its number of points to save processing costs; this is known as Level of Detail (LOD). In our example, we will simply use a fixed number of points, no matter the radius.

GDScript

C#

  1. func draw_circle_arc(center, radius, angle_from, angle_to, color):
  2.     var nb_points = 32
  3.     var points_arc = PoolVector2Array()
  5.     for i in range(nb_points + 1):
  6.         var angle_point = deg2rad(angle_from + i * (angle_to-angle_from) / nb_points - 90)
  7.         points_arc.push_back(center + Vector2(cos(angle_point), sin(angle_point)) * radius)
  9.     for index_point in range(nb_points):
  10.         draw_line(points_arc[index_point], points_arc[index_point + 1], color)
  1. public void DrawCircleArc(Vector2 center, float radius, float angleFrom, float angleTo, Color color)
  2. {
  3.     int nbPoints = 32;
  4.     var pointsArc = new Vector2[nbPoints];
  6.     for (int i = 0; i < nbPoints; ++i)
  7.     {
  8.         float anglePoint = Mathf.Deg2Rad(angleFrom + i * (angleTo - angleFrom) / nbPoints - 90f);
  9.         pointsArc[i] = center + new Vector2(Mathf.Cos(anglePoint), Mathf.Sin(anglePoint)) * radius;
  10.     }
  12.     for (int i = 0; i < nbPoints - 1; ++i)
  13.         DrawLine(pointsArc[i], pointsArc[i + 1], color);
  14. }

Remember the number of points our shape has to be decomposed into? We fixed this number in the nb_points variable to a value of 32. Then, we initialize an empty PoolVector2Array, which is simply an array of Vector2s.

The next step consists of computing the actual positions of these 32 points that compose an arc. This is done in the first for-loop: we iterate over the number of points for which we want to compute the positions, plus one to include the last point. We first determine the angle of each point, between the starting and ending angles.

The reason why each angle is decreased by 90° is that we will compute 2D positions out of each angle using trigonometry (you know, cosine and sine stuff…). However, to be simple, cos() and sin() use radians, not degrees. The angle of 0° (0 radian) starts at 3 o’clock, although we want to start counting at 12 o’clock. So we decrease each angle by 90° in order to start counting from 12 o’clock.

The actual position of a point located on a circle at angle angle (in radians) is given by Vector2(cos(angle), sin(angle)). Since cos() and sin() return values between -1 and 1, the position is located on a circle of radius 1. To have this position on our support circle, which has a radius of radius, we simply need to multiply the position by radius. Finally, we need to position our support circle at the center position, which is performed by adding it to our Vector2 value. Finally, we insert the point in the PoolVector2Array which was previously defined.

Now, we need to actually draw our points. As you can imagine, we will not simply draw our 32 points: we need to draw everything that is between each of them. We could have computed every point ourselves using the previous method, and drew it one by one. But this is too complicated and inefficient (except if explicitly needed), so we simply draw lines between each pair of points. Unless the radius of our support circle is big, the length of each line between a pair of points will never be long enough to see them. If that were to happen, we would simply need to increase the number of points.

Draw the arc on the screen

We now have a function that draws stuff on the screen; it is time to call it inside the _draw() function:

GDScript

C#

  1. func _draw():
  2.     var center = Vector2(200, 200)
  3.     var radius = 80
  4.     var angle_from = 75
  5.     var angle_to = 195
  6.     var color = Color(1.0, 0.0, 0.0)
  7.     draw_circle_arc(center, radius, angle_from, angle_to, color)
  1. public override void _Draw()
  2. {
  3.     var center = new Vector2(200, 200);
  4.     float radius = 80;
  5.     float angleFrom = 75;
  6.     float angleTo = 195;
  7.     var color = new Color(1, 0, 0);
  8.     DrawCircleArc(center, radius, angleFrom, angleTo, color);
  9. }

Result:

../../_images/result_drawarc.png

Arc polygon function

We can take this a step further and not only write a function that draws the plain portion of the disc defined by the arc, but also its shape. The method is exactly the same as before, except that we draw a polygon instead of lines:

GDScript

C#

  1. func draw_circle_arc_poly(center, radius, angle_from, angle_to, color):
  2.     var nb_points = 32
  3.     var points_arc = PoolVector2Array()
  4.     points_arc.push_back(center)
  5.     var colors = PoolColorArray([color])
  7.     for i in range(nb_points + 1):
  8.         var angle_point = deg2rad(angle_from + i * (angle_to - angle_from) / nb_points - 90)
  9.         points_arc.push_back(center + Vector2(cos(angle_point), sin(angle_point)) * radius)
  10.     draw_polygon(points_arc, colors)
  1. public void DrawCircleArcPoly(Vector2 center, float radius, float angleFrom, float angleTo, Color color)
  2. {
  3.     int nbPoints = 32;
  4.     var pointsArc = new Vector2[nbPoints + 1];
  5.     pointsArc[0] = center;
  6.     var colors = new Color[] { color };
  8.     for (int i = 0; i < nbPoints; ++i)
  9.     {
  10.         float anglePoint = Mathf.Deg2Rad(angleFrom + i * (angleTo - angleFrom) / nbPoints - 90);
  11.         pointsArc[i + 1] = center + new Vector2(Mathf.Cos(anglePoint), Mathf.Sin(anglePoint)) * radius;
  12.     }
  14.     DrawPolygon(pointsArc, colors);
  15. }

../../_images/result_drawarc_poly.png

Dynamic custom drawing

All right, we are now able to draw custom stuff on the screen. However, it is static; let’s make this shape turn around the center. The solution to do this is simply to change the angle_from and angle_to values over time. For our example, we will simply increment them by 50. This increment value has to remain constant or else the rotation speed will change accordingly.

First, we have to make both angle_from and angle_to variables global at the top of our script. Also note that you can store them in other nodes and access them using get_node().

GDScript

C#

  1. extends Node2D
  3. var rotation_angle = 50
  4. var angle_from = 75
  5. var angle_to = 195
  1. public class CustomNode2D : Node2D
  2. {
  3.     private float _rotationAngle = 50;
  4.     private float _angleFrom = 75;
  5.     private float _angleTo = 195;
  6. }

We make these values change in the _process(delta) function.

We also increment our angle_from and angle_to values here. However, we must not forget to wrap() the resulting values between 0 and 360°! That is, if the angle is 361°, then it is actually 1°. If you don’t wrap these values, the script will work correctly, but the angle values will grow bigger and bigger over time until they reach the maximum integer value Godot can manage (2^31 - 1). When this happens, Godot may crash or produce unexpected behavior.

Finally, we must not forget to call the update() function, which automatically calls _draw(). This way, you can control when you want to refresh the frame.

GDScript

C#

  1. func _process(delta):
  2.     angle_from += rotation_angle
  3.     angle_to += rotation_angle
  5.     # We only wrap angles when both of them are bigger than 360.
  6.     if angle_from > 360 and angle_to > 360:
  7.         angle_from = wrapf(angle_from, 0, 360)
  8.         angle_to = wrapf(angle_to, 0, 360)
  9.     update()
  1. public override void _Process(float delta)
  2. {
  3.     _angleFrom += _rotationAngle;
  4.     _angleTo += _rotationAngle;
  6.     // We only wrap angles when both of them are bigger than 360.
  7.     if (_angleFrom > 360 && _angleTo > 360)
  8.     {
  9.         _angleFrom = Mathf.Wrap(_angleFrom, 0, 360);
  10.         _angleTo = Mathf.Wrap(_angleTo, 0, 360);
  11.     }
  12.     Update();
  13. }

Also, don’t forget to modify the _draw() function to make use of these variables:

GDScript

C#

  1. func _draw():
  2.    var center = Vector2(200, 200)
  3.    var radius = 80
  4.    var color = Color(1.0, 0.0, 0.0)
  6.    draw_circle_arc( center, radius, angle_from, angle_to, color )
  1. public override void _Draw()
  2. {
  3.     var center = new Vector2(200, 200);
  4.     float radius = 80;
  5.     var color = new Color(1, 0, 0);
  7.     DrawCircleArc(center, radius, _angleFrom, _angleTo, color);
  8. }

Let’s run! It works, but the arc is rotating insanely fast! What’s wrong?

The reason is that your GPU is actually displaying the frames as fast as it can. We need to “normalize” the drawing by this speed; to achieve that, we have to make use of the delta parameter of the _process() function. delta contains the time elapsed between the two last rendered frames. It is generally small (about 0.0003 seconds, but this depends on your hardware), so using delta to control your drawing ensures that your program runs at the same speed on everybody’s hardware.

In our case, we simply need to multiply our rotation_angle variable by delta in the _process() function. This way, our 2 angles will be increased by a much smaller value, which directly depends on the rendering speed.

GDScript

C#

  1. func _process(delta):
  2.     angle_from += rotation_angle * delta
  3.     angle_to += rotation_angle * delta
  5.     # We only wrap angles when both of them are bigger than 360.
  6.     if angle_from > 360 and angle_to > 360:
  7.         angle_from = wrapf(angle_from, 0, 360)
  8.         angle_to = wrapf(angle_to, 0, 360)
  9.     update()
  1. public override void _Process(float delta)
  2. {
  3.     _angleFrom += _rotationAngle * delta;
  4.     _angleTo += _rotationAngle * delta;
  6.     // We only wrap angles when both of them are bigger than 360.
  7.     if (_angleFrom > 360 && _angleTo > 360)
  8.     {
  9.         _angleFrom = Wrap(_angleFrom, 0, 360);
  10.         _angleTo = Wrap(_angleTo, 0, 360);
  11.     }
  12.     Update();
  13. }

Let’s run again! This time, the rotation displays fine!

Tools

Drawing your own nodes might also be desired while running them in the editor to use as a preview or visualization of some feature or behavior.

Remember to use the “tool” keyword at the top of the script (check the GDScript basics reference if you forgot what this does).