From cbed20645f94a3546bb88c2fba007a0c1110c677 Mon Sep 17 00:00:00 2001
From: Simon Schneegans <code@simonschneegans.de>
Date: Wed, 2 Nov 2022 21:08:18 +0100
Subject: [PATCH] :memo: Add some comments

---
 resources/shaders/common.glsl | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/resources/shaders/common.glsl b/resources/shaders/common.glsl
index 4dc9201..0201fe2 100644
--- a/resources/shaders/common.glsl
+++ b/resources/shaders/common.glsl
@@ -183,13 +183,18 @@ float getRelativeEdgeMask(float fadeAmount) {
 
 // ------------------------------------------------------------------------------- 2D math
 
+// Returns the shortest distance between the given point and the line defined by "origin"
+// and "direction".
 float distToLine(vec2 origin, vec2 direction, vec2 point) {
   vec2 perpendicular = vec2(direction.y, -direction.x);
   return abs(dot(normalize(perpendicular), origin - point));
 }
 
+// Returns a positive number if a -> b forms a clockwise corner, or a negative number if
+// the corner is counter-clockwise.
 float getWinding(vec2 a, vec2 b) { return cross(vec3(a, 0.0), vec3(b, 0.0)).z; }
 
+// Rotates the given 2D vector a clockwise by the angle alpha (given in radians).
 vec2 rotate(vec2 a, float angle) {
   return vec2(a.x * cos(angle) - a.y * sin(angle), a.x * sin(angle) + a.y * cos(angle));
 }