Add dispose warning to screenshot! function

2014-04-08 14:18:07 -04:00
parent 986fc91fe4
commit f8c8d65ae1
1 changed files with 2 additions and 1 deletions
--- a/src/play_clj/core_utils.clj
+++ b/src/play_clj/core_utils.clj
@@ -9,7 +9,8 @@

 (defn screenshot!
  "Captures a screenshot and either returns it as a `pixmap` or saves it to the
-specified path.
+specified path. Note that when a `pixmap` is no longer needed, you must call
+`(pixmap! object :dispose)` to clear it from memory.

    (screenshot!)
    (screenshot! \"out.png\")