ImageTexture¶
Inherits: Texture < Resource < Reference < Object
Description¶
A Texture based on an Image. Can be created from an Image with create_from_image.
Note: The maximum image size is 16384×16384 pixels due to graphics hardware limitations. Larger images will fail to import.
Methods¶
void |
create ( int width, int height, Format format, int flags=7 ) |
void |
create_from_image ( Image image, int flags=7 ) |
get_format ( ) const |
|
void |
|
void |
set_size_override ( Vector2 size ) |
Enumerations¶
enum Storage:
STORAGE_RAW = 0 --- Image data is stored raw and unaltered.
STORAGE_COMPRESS_LOSSY = 1 --- Image data is compressed with a lossy algorithm. You can set the storage quality with lossy_quality.
STORAGE_COMPRESS_LOSSLESS = 2 --- Image data is compressed with a lossless algorithm.
Property Descriptions¶
float lossy_quality
Default |
|
Setter |
set_lossy_storage_quality(value) |
Getter |
get_lossy_storage_quality() |
The storage quality for STORAGE_COMPRESS_LOSSY.
Storage storage
Default |
|
Setter |
set_storage(value) |
Getter |
get_storage() |
The storage type (raw, lossy, or compressed).
Method Descriptions¶
Create a new ImageTexture
with width
and height
.
format
is a value from Format, flags
is any combination of Flags.
Create a new ImageTexture
from an Image with flags
from Flags. An sRGB to linear color space conversion can take place, according to Format.
Format get_format ( ) const
Returns the format of the ImageTexture
, one of Format.
Load an ImageTexture
from a file path.
void set_data ( Image image )
Sets the Image of this ImageTexture
.
void set_size_override ( Vector2 size )
Resizes the ImageTexture
to the specified dimensions.