Add docs for trans

MikeTam1021 · Oct 28, 2013 · 1ff8393 · 1ff8393
1 parent aa63305
commit 1ff8393
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/tmxlib/image.py b/tmxlib/image.py
@@ -30,8 +30,14 @@ def open(filename, trans=None, size=None):
 
     :param filename: Name of the file to load the image from
     :param trans:
-        Optional color that should be rendered as transparent
-        (this is not implemented yet)
+        Optional color that should be loaded as transparent
+
+        .. note::
+
+            Currently, loading images that use color-key transparency
+            is very inefficient.
+            If possible, use the alpha channel instead.
+
     :param size:
         Optional (width, height) tuple.
         If specified, the file will not be read from disk when the image size

diff --git a/tmxlib/image_base.py b/tmxlib/image_base.py
@@ -106,7 +106,13 @@ class Image(ImageBase, fileio.ReadWriteBase):
 
         .. attribute:: trans
 
-            A color key used for transparency (currently not implemented)
+            A color key used for transparency
+
+            .. note::
+
+                Currently, loading images that use color-key transparency
+                is very inefficient.
+                If possible, use the alpha channel instead.
 
     Images support indexing (``img[x, y]``); see
     :meth:`tmxlib.image_base.ImageBase.__getitem__`