View source for LMD VCL - Glyph Transparency

== Transparency source ==

=== Standard TImageLists ===

All image list component, including standard <code>TImageList</code> provides some sort of intrinsic transparency.  For example:

[[file:1ca3303f-b2c6-44a2-b2fd-43d9c8797d7b.png]]

The icon, shown above, can be imported into image list differently, and will have or have no transparent parts depending of transparent color, specified during importing.

First, let the component editor choose auto transparent color:

[[file:6f7fe0a7-5e8c-40f2-905d-3e154b0e853b.png]]

Second, let override the color:

[[file:d5486f3f-21d5-4ac3-8078-760ad9db6be0.png]]

As a result we'll get two different image list items with different transparent pixels, generated from the same image file. And the second item have no transparent pixels at all, so its magenta backgound should be pained as a part of image to the final destination canvas. 

Note also, that transparent colors are not a property of image list items. Colors was used only during importing.

[[file:7080954d-dea9-44c2-b2fb-a9f202a6d76b.png]]

Imagelists with 32-bit color depth provide native support for alpha channel transparency. By default (which is important ot note), all importing 32-bit bitmaps are treated as transparency-enabled by the component editor.

In addition to the descripbed aspects, transparent pixels can be affected by <code>TImageList</code> component properties, like <code>BkColor</code> and <code>DrawingStyle</code>.

> So, the colclusion: <code>TImageList</code> provides intrinsic transparency, which depends of transparent color, specified during image importing, 32-bit color depth, and, <code>BkColor</code> and <code>DrawingStyle</code> properties.

=== TVirtualImageList ===

As well new virtual image lists can import 32-bit bitmaps, pngs, ect. So, such image lists provide complex (not quite understandable) intrinsic transparency, which we should respected. 

=== TLMDImageList ===

LMD image list component provides <code>TLMDCustomImageList.TransparentColor</code> as "official way" to get information about item transparency. This is used in <code>LMDIMLTransparentColor</code> global function. 32-bit images are not supported currently.

=== Glyph properties ===

Since <code>TBitmap</code> type of <code>Glyph</code> properties provides no ways to customize transparency during image importing time (as opposed to <code>TImageList</code>), all 24-bit bitmaps should be treated as color-key transparent, while all 32-bit bitmaps should be treated as alpha-transparent.

== Implementation details ==

LMD- Tools controls almost always draw initial graphics (from image list or a <code>Glyph</code> prroperty) onto the temporary bitmap buffer. 

=== Image lists ===

In case of image list graphics source <code>LMDIMLItemBitmap</code> function is used. 

For image lists with 32-bit color deptch we adjust destination bitmap pixel format to be also 32-bit, and alpha format to be defined.

For other (24-bit) image lists its hard if not impossible at all to deduct which transparency rules are really used. Moreover, <code>TCustomImageList.DoDraw</code> method is virtual, allowing descendants to do anything. So, in this case we have no better solution than to draw image list item into bitmap, prefilled with some exotic color, and then use this color as a transparent color key. I've declared the following global variable for this:

[[file:4be1aa7c-2a6c-4f66-a73b-e0f05b624ffc.png]]

This way all intrinsic image list transparency, described above will be respected as much as possible.

For controls, which provide <code>TransparentColor</code> customization property, the property value is used to fill buffer bitmap instead of global value described above.

=== Glyph properties ===

As noted above, 32-bit bitmaps loaded into <code>Glyph</code> property are treated as alpha-enabled. However, we cannot set original bitmap <code>AlphaFormat</code> to <code>afDefined</code>, because this causes internal bitmap data to be premultiplied. And this is wrong, because published property data should be leaved unchanged for potential dfm (re)saving at design-time.

So, any Glyph property graphics have to be copied into some temporary buffer bitmaps, in which alpha support can be turned on. <code>TLMDGlyph</code> class caches and reuses such buffer bitmaps.

Other (24-bit) graphics uses standard <code>TBitmap.TrnsparentColor</code> feature to auto-detect transparent color, unless the control provides its own color property.

=== Internal Api ===

So, it seems that any kind of transparency can be represented with simple <code>TBitmap</code> object, and transfering additional parameters such as <code>TransparentColor</code> or <code>Mask</code> is not really required. However, for now, and for more explicit code, I've declared special <code>TLMFGlypTransp</code> record with some public methods for explicit configuration.

The record values are used as parameter values in <code>LMDDrawTextAndGlyph</code>, <code>LMDDrawTextAndGlyphExt</code> and <code>LMDBmpDrawExt</code> functions, which was modified to update transparency semantics. These function are now able to draw 32-bit bitmaps, as well, as color-key transparency bitmaps.

<code>LMDIMLItemBitmap</code> function was also modified to produce 32-bit bitmaps if required, and to support prefilling of 24-bit bitmaps with required color-key.

<code>LMDIMLTransparentColor</code> function (as has been mentioned above) was modified to report <code>LMDDefaultImageListTransparentColor</code> color as a transparent color for non-LMD image lists.

<code>TLMDGlyph</code> class was changed also. It does not use image lists to cache bitmaps anymore. Inidividual <code>TBitmap</code> objects are used instead. Both: color-key and alpha channel are supported.

Also, <code>TLMDGlyph</code> class got new <code>OnGetBitmap</code> event, which allow to grab the bitmap from other sources (such as image list or standard glyph from resources) leaving <code>Glyph</code> bitmap unchanged.

=== Controls ===

Controls, which provide several glyph sources, like <code>Glyph</code>, <code>ImageList</code>/<code>ImageIndex</code>, <code>GlyphKind</code> properties now implement mutual properties semantic, e.g. setting one of the properties will reset all others to default values. <code>TLMDGlyph.OnGetBitmap</code> is used internally.

<code>TransparentColor</code> and <code>GlyphTransparent</code> control properties are respected using <code>TLMFGlypTransp</code> record configuration methods.  In extreme (wrong) case where image list item provides some transparent pixels and, at the same time, <code>GlyphTransparent</code> is set to <code>False</code>, the user will see <code>LMDDefaultImageListTransparentColor</code> backgound.

For 32-bit graphics <code>GlyphTransparent</code> properties are ignored.

=== Actions ===

Action images are now linked via <code>ImageList</code>/<code>ImageIndex</code> control's properties, as opposed to old <code>Glyph</code> way. Using image lists instead of <code>Glyph</code> bitmaps provides auto DPI csaling in case of virtual image lists.

In Delphi action only takes care of <code>ImageIndex</code> property, so, control's <code>ImageList</code> itself is not affected. I've adjusted this strategy to the following:

* if control's <code>ImageList</code> is nil, we link it from the corresponding action list.
* Linked <code>ImageList</code> can be overidden by the user to another <code>ImageList</code>. And, thus, become not linked anymore.

Linked properties are not stored in dfm.

=== Design-time editors ===

<code>TImageList</code> standard component editor poorly support 32-bit bitmaps. As well it wrongly import transparent png files. At the same time <code>TImageList</code> itself can support all of this stuff very well.

Another one mising feature - drag&drop image filles directly into the editor. From desktop or file explorer, as well as from special icons tools, like Pichon.

<code>Glyph</code> properties of <code>TBitmap</code> type allow to import 32-bit bitmaps correctly. But, custom property editor can also allow to load transparent png files directly into bitmap properties. As well, drag&drop support can be added.

> So, the idea - develop replacement for standard image list component editor and <code>TBitmap</code> property editor.

=== Font based image list ===

> We can create new font based image list to be used with Windows 10 Segoe Mdl2 Assets font.

Not very hard to implement. Will provide: 

* Re-coloring on-the-fly (useful for VCL Styles scenario)
* DPI scaling, like virtual image list
* Clear type (sub-pixel anti-aliasing)
* XE2 support for our own use (in demos), since TVirtualImageList does not exist in XE2, so no DPI scaling of images is possible in XE2.
* Much simpler than SVG image list.