mirror of
https://github.com/godotengine/godot.git
synced 2024-12-27 11:24:59 +08:00
34 lines
2.1 KiB
XML
34 lines
2.1 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="CompressedTexture2D" inherits="Texture2D" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
|
|
<brief_description>
|
|
Texture with 2 dimensions, optionally compressed.
|
|
</brief_description>
|
|
<description>
|
|
A texture that is loaded from a [code].ctex[/code] file. This file format is internal to Godot; it is created by importing other image formats with the import system. [CompressedTexture2D] can use one of 4 compression methods (including a lack of any compression):
|
|
- Lossless (WebP or PNG, uncompressed on the GPU)
|
|
- Lossy (WebP, uncompressed on the GPU)
|
|
- VRAM Compressed (compressed on the GPU)
|
|
- VRAM Uncompressed (uncompressed on the GPU)
|
|
- Basis Universal (compressed on the GPU. Lower file sizes than VRAM Compressed, but slower to compress and lower quality than VRAM Compressed)
|
|
Only [b]VRAM Compressed[/b] actually reduces the memory usage on the GPU. The [b]Lossless[/b] and [b]Lossy[/b] compression methods will reduce the required storage on disk, but they will not reduce memory usage on the GPU as the texture is sent to the GPU uncompressed.
|
|
Using [b]VRAM Compressed[/b] also improves loading times, as VRAM-compressed textures are faster to load compared to textures using lossless or lossy compression. VRAM compression can exhibit noticeable artifacts and is intended to be used for 3D rendering, not 2D.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="load">
|
|
<return type="int" enum="Error" />
|
|
<param index="0" name="path" type="String" />
|
|
<description>
|
|
Loads the texture from the specified [param path].
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="load_path" type="String" setter="load" getter="get_load_path" default="""">
|
|
The [CompressedTexture2D]'s file path to a [code].ctex[/code] file.
|
|
</member>
|
|
<member name="resource_local_to_scene" type="bool" setter="set_local_to_scene" getter="is_local_to_scene" overrides="Resource" default="false" />
|
|
</members>
|
|
</class>
|