draw: add doc strings and note to DrawImage.image_2d(...)

larpon · Sep 28, 2023 · 1667141 · 1667141
1 parent 87a03aa
commit 1667141
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/draw2d.image.b.v b/lib/draw2d.image.b.v
@@ -27,7 +27,10 @@ pub fn (mut di DrawImage) end() {
 	// gl.draw()
 }
 
+// image_2d returns an initialized Draw2DImage struct.
+// NOTE `image` is passed by reference because building with `-gc none` otherwise leaks.
 pub fn (di DrawImage) image_2d(image &Image) Draw2DImage {
+
 	return Draw2DImage{
 		factor: di.factor
 		width: image.width