Difference between revisions of "CompressedData"

m
m (Remove love.math parent)
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{newin|[[0.9.0]]|090|type=object}}
+
{{newin|[[0.10.0]]|100|type=type|text=In versions prior to [[0.10.0]] the CompressedData name was used for [[CompressedImageData]] objects}}
Compressed image data designed to stay compressed in RAM and on the GPU. Encompasses standard compressed formats such as [http://renderingpipeline.com/2012/07/texture-compression/  DXT1, DXT5, and BC5 / 3Dc].
+
Represents byte data compressed using a specific algorithm.
 +
 
 +
[[love.data.decompress]] can be used to de-compress the data (or [[love.math.decompress]] in [[0.10.2]] or earlier).
  
You can't draw CompressedData directly to the screen. See [[Image]] for that.
 
 
== Constructors ==
 
== Constructors ==
{{#ask: [[Category:Functions]] [[Constructs::CompressedData]] [[Concept:Current]]
+
{{#ask: [[Category:Functions]] [[Constructs::CompressedData]]
 
| headers=hide
 
| headers=hide
 
| format=template
 
| format=template
Line 13: Line 14:
 
| ?PrettySince
 
| ?PrettySince
 
| ?PrettyRemoved
 
| ?PrettyRemoved
 +
| ?PrettyDeprecated
 
}}
 
}}
  
 
== Functions ==
 
== Functions ==
{{#ask: [[Category:Functions]] [[parent::CompressedData||Data||Object]] [[Concept:Current]]
+
{{#ask: [[Category:Functions]] [[parent::CompressedData||Data||Object]]
 
| headers=hide
 
| headers=hide
 
| format=template
 
| format=template
Line 25: Line 27:
 
| ?PrettySince
 
| ?PrettySince
 
| ?PrettyRemoved
 
| ?PrettyRemoved
 +
| ?PrettyDeprecated
 
}}
 
}}
  
 
== Enums ==
 
== Enums ==
{{#ask: [[Category:Enums]] [[parent::CompressedData]] [[Concept:Current]]
+
{{#ask: [[Category:Enums]] [[parent::CompressedData]]
 
| headers=hide
 
| headers=hide
 
| format=template
 
| format=template
Line 37: Line 40:
 
| ?PrettySince
 
| ?PrettySince
 
| ?PrettyRemoved
 
| ?PrettyRemoved
 +
| ?PrettyDeprecated
 
}}
 
}}
  
Line 42: Line 46:
 
* [[parent::Data]]
 
* [[parent::Data]]
 
* [[parent::Object]]
 
* [[parent::Object]]
 +
 
== See Also ==
 
== See Also ==
* [[parent::love.image]]
+
* [[parent::love.data]]
* [[love.image.isCompressed]]
+
* [[parent::love.data.decompress]]
* [[Image]]
+
* [[love.math]] (deprecated since 11.0)
 +
* [[love.math.decompress]] (deprecated since 11.0)
 
[[Category:Types]]
 
[[Category:Types]]
{{#set:Description=Compressed image data designed to stay compressed in RAM and on the GPU.}}
+
{{#set:Description=Byte data compressed using a specific algorithm.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|CompressedData}}
 
{{i18n|CompressedData}}

Latest revision as of 15:01, 30 July 2020

Available since LÖVE 0.10.0
In versions prior to 0.10.0 the CompressedData name was used for CompressedImageData objects.

Represents byte data compressed using a specific algorithm.

love.data.decompress can be used to de-compress the data (or love.math.decompress in 0.10.2 or earlier).

Constructors

love.data.compress Compresses a string or data using a specific compression algorithm. Added since 11.0
love.math.compress Compresses a string or data using a specific compression algorithm. Added since 0.10.0 Deprecated in 11.0

Functions

CompressedData:getFormat Gets the compression format of the CompressedData. Added since 0.10.0
Data:clone Creates a new copy of the Data object. Added since 11.0
Data:getFFIPointer Gets an FFI pointer to the Data. Added since 11.3
Data:getPointer Gets a pointer to the Data.
Data:getSize Gets the Data's size in bytes.
Data:getString Gets the full Data as a string. Added since 0.9.0
Object:release Immediately destroys the object's Lua reference. Added since 11.0
Object:type Gets the type of the object as a string.
Object:typeOf Checks whether an object is of a certain type.

Enums

CompressedDataFormat Compressed data formats. Added since 0.10.0

Supertypes

See Also

Other Languages