From e99e29c5c6bf6ba12a478d2333a9d6f020592209 Mon Sep 17 00:00:00 2001
From: LLLL Colonq <llll@colonq>
Date: Tue, 18 Feb 2025 21:12:32 -0500
Subject: Document a bit

---
 templates/api/throwshade.html | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'templates/api/throwshade.html')

diff --git a/templates/api/throwshade.html b/templates/api/throwshade.html
index ae57991..dcf7a9c 100644
--- a/templates/api/throwshade.html
+++ b/templates/api/throwshade.html
@@ -34,6 +34,13 @@ CONFIG_SUBST
       <div id="lcolonq-throwshade-bottom">
         <div id="lcolonq-throwshade-bottom-left">
           <textarea id="lcolonq-throwshade-textarea">
+// how to:
+// the parameter "cs" is a screen coordinate - it ranges from (0, 0) in the top left
+// to (1.0, 1.0) in the bottom right
+// available uniforms:
+// float time - time in seconds since shader started
+// vec2 resolution - display resolution in pixels (it's 1920x1080 :3)
+// float chat_time - timestamp (in seconds since shader started) of last chat message
 vec4 shade(vec2 cs) {
     return vec4(0.0, 1.0, 0.0, 1.0);
 }
-- 
cgit v1.2.3