godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/PortableCompressedTexture2D...

80 lines
4.0 KiB
XML
Raw Normal View History

Add PortableCompressedTexture * Resource that allows saving textures embedded in scenes or standalone. * Supports only formats that are portable: Lossy, Lossles or BasisUniversal This is something I wanted to add for a long time. I made it now because @fire requires it for importing GLTF2 files with embedded textures, but also this will allow saving Godot scenes as standalone binary files that will run in all platforms (because textures will load everywhere). This is ideal when you want to distribute individual standalone assets online in games that can be built from Godot scenes.
2022-03-24 17:18:55 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PortableCompressedTexture2D" inherits="Texture2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Provides a compressed texture for disk and/or VRAM in a way that is portable.
</brief_description>
<description>
This class allows storing compressed textures as self contained (not imported) resources.
For 2D usage (compressed on disk, uncompressed on VRAM), the lossy and lossless modes are recommended. For 3D usage (compressed on VRAM) it depends on the target platform.
If you intend to only use desktop, S3TC or BPTC are recommended. For only mobile, ETC2 is recommended.
For portable, self contained 3D textures that work on both desktop and mobile, Basis Universal is recommended (although it has a small quality cost and longer compression time as a tradeoff).
This resource is intended to be created from code.
</description>
<tutorials>
</tutorials>
<methods>
<method name="create_from_image">
<return type="void" />
<argument index="0" name="image" type="Image" />
<argument index="1" name="compression_mode" type="int" enum="PortableCompressedTexture2D.CompressionMode" />
<argument index="2" name="normal_map" type="bool" default="false" />
<argument index="3" name="lossy_quality" type="float" default="0.8" />
<description>
Initializes the compressed texture from a base image. The compression mode must be provided.
If this image will be used as a normal map, the "normal map" flag is recommended, to ensure optimum quality.
If lossy compression is requested, the quality setting can optionally be provided. This maps to Lossy WEBP compression quality.
</description>
</method>
<method name="get_compression_mode" qualifiers="const">
<return type="int" enum="PortableCompressedTexture2D.CompressionMode" />
<description>
Return the compression mode used (valid after initialized).
</description>
</method>
<method name="get_format" qualifiers="const">
<return type="int" enum="Image.Format" />
<description>
Return the image format used (valid after initialized).
</description>
</method>
<method name="is_keeping_all_compressed_buffers" qualifiers="static">
<return type="bool" />
<description>
Fix typos with codespell Using codespell 2.2-dev from current git. Fix a couple incorrect uses of gendered pronouns.
2022-03-31 12:06:10 +00:00
Return whether the flag is overridden for all textures of this type.
Add PortableCompressedTexture * Resource that allows saving textures embedded in scenes or standalone. * Supports only formats that are portable: Lossy, Lossles or BasisUniversal This is something I wanted to add for a long time. I made it now because @fire requires it for importing GLTF2 files with embedded textures, but also this will allow saving Godot scenes as standalone binary files that will run in all platforms (because textures will load everywhere). This is ideal when you want to distribute individual standalone assets online in games that can be built from Godot scenes.
2022-03-24 17:18:55 +00:00
</description>
</method>
<method name="set_keep_all_compressed_buffers" qualifiers="static">
<return type="void" />
<argument index="0" name="keep" type="bool" />
<description>
Fix typos with codespell Using codespell 2.2-dev from current git. Fix a couple incorrect uses of gendered pronouns.
2022-03-31 12:06:10 +00:00
Overrides the flag globally for all textures of this type. This is used primarily by the editor.
Add PortableCompressedTexture * Resource that allows saving textures embedded in scenes or standalone. * Supports only formats that are portable: Lossy, Lossles or BasisUniversal This is something I wanted to add for a long time. I made it now because @fire requires it for importing GLTF2 files with embedded textures, but also this will allow saving Godot scenes as standalone binary files that will run in all platforms (because textures will load everywhere). This is ideal when you want to distribute individual standalone assets online in games that can be built from Godot scenes.
2022-03-24 17:18:55 +00:00
</description>
</method>
</methods>
<members>
<member name="_data" type="PackedByteArray" setter="_set_data" getter="_get_data" default="PackedByteArray()">
</member>
<member name="keep_compressed_buffer" type="bool" setter="set_keep_compressed_buffer" getter="is_keeping_compressed_buffer" default="false">
When running on the editor, this class will keep the source compressed data in memory. Otherwise, the source compressed data is lost after loading and the resource can't be re saved.
This flag allows to keep the compressed data in memory if you intend it to persist after loading.
</member>
<member name="size_override" type="Vector2" setter="set_size_override" getter="get_size_override" default="Vector2(0, 0)">
Allow overriding the texture size (for 2D only).
</member>
</members>
<constants>
<constant name="COMPRESSION_MODE_LOSSLESS" value="0" enum="CompressionMode">
</constant>
<constant name="COMPRESSION_MODE_LOSSY" value="1" enum="CompressionMode">
</constant>
<constant name="COMPRESSION_MODE_BASIS_UNIVERSAL" value="2" enum="CompressionMode">
</constant>
<constant name="COMPRESSION_MODE_S3TC" value="3" enum="CompressionMode">
</constant>
<constant name="COMPRESSION_MODE_ETC2" value="4" enum="CompressionMode">
</constant>
<constant name="COMPRESSION_MODE_BPTC" value="5" enum="CompressionMode">
</constant>
</constants>
</class>