Types/BlendMode: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Clarify formula for normal blending.)
(Removed old prototype docs)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
A [[Types/string]] that determines how sprites/animations should blend with the background. The possible values are listed below.
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/types/BlendMode.html https://lua-api.factorio.com/latest/types/BlendMode.html]


Note: In most of Factorio it is assumed colors are in alpha premultiplied format: [https://www.factorio.com/blog/post/fff-172 FFF #172 - Blending and Rendering]. Sprites get premultiplied when loaded, unless <code>premul_alpha</code> is set to false on the sprite/animation itself. But generating mipmaps doesn't respect <code>premul_alpha</code>, so lowel mipmap levels will be in premultiplied format regardless.
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
== Possible values ==
=== normal ===
The result color is determined with the following formula:
<code>Result = Active_RGB + Background_RGB * ( 1 - Active_Alpha )</code>
 
Note: This is alpha blending with an assumption that Active_RGB is already premultiplied with Active_Alpha.
 
=== additive ===
The result color is determined with the following formula:
<code>Result = Active_RGB + Background_RGB</code>
 
=== additive-soft ===
The result color is determined with the following formula:
<code>Result = Active_RGB * ( 1 - Background_RGB ) + Background_RGB</code>
 
=== multiplicative ===
The result color is determined with the following formula:
<code>Result = Active_RGB * Background_RGB</code>
 
=== overwrite ===
The result color is determined with the following formula:
<code>Result = Active_RGBA or Background_RGBA</code>

Latest revision as of 14:32, 25 October 2024

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/types/BlendMode.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.