SF.net SVN: alleg:[14766] allegro/branches/5.1/docs/src/refman/graphics.txt

[<sie...@us...>]

Revision: 14766
          http://alleg.svn.sourceforge.net/alleg/?rev=14766&view=rev
Author:   siegelord
Date:     2011-06-09 00:31:11 +0000 (Thu, 09 Jun 2011)

Log Message:
-----------
Mention the minimum texture size under D3D and NPOT textures in the documentation of al_create_bitmap

Modified Paths:
--------------
    allegro/branches/5.1/docs/src/refman/graphics.txt

Modified: allegro/branches/5.1/docs/src/refman/graphics.txt
===================================================================
--- allegro/branches/5.1/docs/src/refman/graphics.txt	2011-06-08 17:40:35 UTC (rev 14765)
+++ allegro/branches/5.1/docs/src/refman/graphics.txt	2011-06-09 00:31:11 UTC (rev 14766)
@@ -259,8 +259,19 @@
 allowed dimensions. For example a DirectX or OpenGL backend usually
 has a maximum allowed texture size - so if bitmap creation fails
 for very large dimensions, you may want to re-try with a smaller
-bitmap.
+bitmap. Some platforms also dictate a minimum texture size, which is
+relevant if you plan to use this bitmap with the primitives addon. If
+you try to create a bitmap smaller than this, this call will not fail
+but the returned bitmap will be a section of a larger bitmap with the
+minimum size. This minimum size is 16 by 16.
 
+Some platforms do not directly support display bitmaps whose dimensions
+are not powers of two. Allegro handles this by creating a larger bitmap
+that has dimensions that are powers of two and then returning a section
+of that bitmap with the dimensions you requested. This can be relevant
+if you plan to use this bitmap with the primitives addon but shouldn't
+be an issue otherwise.
+
 If you create a bitmap without ALLEGRO_MEMORY_BITMAP set but there is
 no current display, a temporary memory bitmap will be created instead.
 You can later convert all such bitmap to video bitmap and assign to a


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.