Browse Source

Update supported texture formats;

bjorn 6 years ago
parent
commit
95e7d5c373
3 changed files with 6 additions and 6 deletions
  1. 2 2
      api/init.lua
  2. 2 1
      api/lovr/data/TextureData/init.lua
  3. 2 3
      api/lovr/graphics/Texture/init.lua

+ 2 - 2
api/init.lua

@@ -3171,7 +3171,7 @@ return {
         {
         {
           name = "TextureData",
           name = "TextureData",
           summary = "An object that stores pixel data for Textures.",
           summary = "An object that stores pixel data for Textures.",
-          description = "A TextureData stores raw 2D pixel info for `Texture`s.  It has a width, height, and format.  The TextureData can be initialized with the contents of an image file or it can be created with uninitialized contents.  The supported image formats are `png`, `jpg`, `hdr`, and `dds`.\n\nUsually you can just use Textures, but TextureData can be useful if you want to manipulate individual pixels or load Textures in a background thread.",
+          description = "A TextureData stores raw 2D pixel info for `Texture`s.  It has a width, height, and format.  The TextureData can be initialized with the contents of an image file or it can be created with uninitialized contents.  The supported image formats are `png`, `jpg`, `hdr`, `dds`, `ktx`, and `astc`.\n\nUsually you can just use Textures, but TextureData can be useful if you want to manipulate individual pixels or load Textures in a background thread.",
           key = "TextureData",
           key = "TextureData",
           module = "lovr.data",
           module = "lovr.data",
           methods = {
           methods = {
@@ -11558,7 +11558,7 @@ return {
         {
         {
           name = "Texture",
           name = "Texture",
           summary = "An image that can be applied to Materials.",
           summary = "An image that can be applied to Materials.",
-          description = "A Texture is an image that can be applied to `Material`s.  The supported file formats are `.png`, `.jpg`, and `.hdr`.  Additionally, three compressed formats are supported: DXT1, DXT3, and DXT5 (all have the `.dds` extension).  Compressed textures are generally recommended as they use less video memory and usually improve performance.",
+          description = "A Texture is an image that can be applied to `Material`s.  The supported file formats are `.png`, `.jpg`, `.hdr`, `.dds`, `.ktx`, and `.astc`.  DDS and ASTC are compressed formats, which are recommended because they're smaller and faster.",
           key = "Texture",
           key = "Texture",
           module = "lovr.graphics",
           module = "lovr.graphics",
           methods = {
           methods = {

+ 2 - 1
api/lovr/data/TextureData/init.lua

@@ -3,7 +3,8 @@ return {
   description = [[
   description = [[
     A TextureData stores raw 2D pixel info for `Texture`s.  It has a width, height, and format.  The
     A TextureData stores raw 2D pixel info for `Texture`s.  It has a width, height, and format.  The
     TextureData can be initialized with the contents of an image file or it can be created with
     TextureData can be initialized with the contents of an image file or it can be created with
-    uninitialized contents.  The supported image formats are `png`, `jpg`, `hdr`, and `dds`.
+    uninitialized contents.  The supported image formats are `png`, `jpg`, `hdr`, `dds`, `ktx`, and
+    `astc`.
 
 
     Usually you can just use Textures, but TextureData can be useful if you want to manipulate
     Usually you can just use Textures, but TextureData can be useful if you want to manipulate
     individual pixels or load Textures in a background thread.
     individual pixels or load Textures in a background thread.

+ 2 - 3
api/lovr/graphics/Texture/init.lua

@@ -2,9 +2,8 @@ return {
   summary = 'An image that can be applied to Materials.',
   summary = 'An image that can be applied to Materials.',
   description = [[
   description = [[
     A Texture is an image that can be applied to `Material`s.  The supported file formats are
     A Texture is an image that can be applied to `Material`s.  The supported file formats are
-    `.png`, `.jpg`, and `.hdr`.  Additionally, three compressed formats are supported: DXT1, DXT3,
-    and DXT5 (all have the `.dds` extension).  Compressed textures are generally recommended as they
-    use less video memory and usually improve performance.
+    `.png`, `.jpg`, `.hdr`, `.dds`, `.ktx`, and `.astc`.  DDS and ASTC are compressed formats, which
+    are recommended because they're smaller and faster.
   ]],
   ]],
   constructor = 'lovr.graphics.newTexture'
   constructor = 'lovr.graphics.newTexture'
 }
 }