viscosity/engine/doc/classes/ImageFormatLoader.xml

22 lines
1.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ImageFormatLoader" inherits="RefCounted" api_type="core" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
<brief_description>
Base class to add support for specific image formats.
</brief_description>
<description>
The engine supports multiple image formats out of the box (PNG, SVG, JPEG, WebP to name a few), but you can choose to implement support for additional image formats by extending [ImageFormatLoaderExtension].
</description>
<tutorials>
</tutorials>
<constants>
<constant name="FLAG_NONE" value="0" enum="LoaderFlags" is_bitfield="true">
Default loading behavior. No processing is applied to the image.
</constant>
<constant name="FLAG_FORCE_LINEAR" value="1" enum="LoaderFlags" is_bitfield="true">
If set, the image is converted from sRGB to linear encoding.
</constant>
<constant name="FLAG_CONVERT_COLORS" value="2" enum="LoaderFlags" is_bitfield="true">
If set, a predefined color map is applied to the image. Used when [member ResourceImporterTexture.editor/convert_colors_with_editor_theme] is [code]true[/code].
</constant>
</constants>
</class>