GC#drawIcon draws *.ico(for some icons) with black background on Windows 10 #185

tmssngr · 2022-06-01T08:10:26Z

Describe the bug
Please run the attached snippet on Windows 10 (default Windows mode: Dark, default app mode: light). It will get the icons for certain file types and render them. For some reason, the background of the images is rendered in black.
ProgramImageTest.java.txt

To Reproduce
See above.

Expected behavior
The background should be transparent.

Screenshots

Environment:
Windows 10, Version 21H1 (OS Build 19043.1706)

iloveeclipse · 2022-06-01T08:43:18Z

@tmssngr :

which Eclipse / SWT version is this?
is this a regression? If yes, which version was OK?

tmssngr · 2022-06-01T09:19:45Z

This is reproducible with the latest SWT built from source (v4952r11). With bisecting I've found out that commit 22797d3 Revert "Revert "Bug 493455 - [win32] remove alpha and alphaData from Image"" introduced this bug.

niraj-modi · 2022-06-01T10:10:27Z

This is reproducible with the latest SWT built from source (v4952r11). With bisecting I've found out that commit 22797d3 Revert "Revert "Bug 493455 - [win32] remove alpha and alphaData from Image"" introduced this bug.

@jonathan.meier@outlook.com
Please have a look.

niraj-modi · 2022-06-01T11:42:22Z

I don't see this problem happening in Eclipse.

@SyntevoAlex @Phillipus
Do you see this problem in any of you Eclipse based applications ?
We are just trying to understand how severe is this problem.

Phillipus · 2022-06-01T11:52:50Z

I don't have those program icons on my system, so when I run the snippet the program icons I have render OK. @tmssngr Can we get an actual icon to test with? Also, is this Hi DPI?

niraj-modi · 2022-06-01T12:01:49Z

I don't have those program icons on my system, so when I run the snippet the program icons I have render OK. @tmssngr Can we get an actual icon to test with? Also, is this Hi DPI?

Please share a screen grab on how the icon looks for you.

Phillipus · 2022-06-01T12:18:48Z

Please share a screen grab on how the icon looks for you.

Phillipus · 2022-06-01T12:29:02Z

Found it.

I had to set Windows custom scaling to 200 or run the snippet with the argument -Dswt.autoScale=200

niraj-modi · 2022-06-01T12:46:30Z

Eclipse at HiDPI is working fine for External Program Icons:

So problem seems specific to this test-snippet only.

Phillipus · 2022-06-01T13:00:00Z

It seems to be only some Program icons that have this problem.

Try running this modified snippet:

Modified Snippet

import java.util.List;
import java.util.*;

import org.eclipse.swt.*;
import org.eclipse.swt.graphics.*;
import org.eclipse.swt.program.*;
import org.eclipse.swt.widgets.*;

public class ProgramImageTest {

    public static void main(String[] args) {
        final Display display = new Display();

        final List<Image> images = createImages(display);

        final Shell shell = new Shell(display);

        shell.addListener(SWT.Paint, event -> {
            int x = 0;
            int y = 0;
            for(Image image : images) {
                event.gc.drawImage(image, x, y);
                x += image.getImageData().width;
                x += 10;
                if(x > 400) {
                    x = 0;
                    y += 24;
                }
            }
        });

        shell.setSize(400, 300);
        shell.open();

        while(!shell.isDisposed()) {
            if(!display.readAndDispatch()) {
                display.sleep();
            }
        }

        for(Image image : images) {
            image.dispose();
        }

        display.dispose();
    }

    private static List<Image> createImages(Display display) {
        final List<Image> images = new ArrayList<>();

        for(Program p : Program.getPrograms()) {
            final ImageData data = p.getImageData();
            if(data == null) {
                continue;
            }

            images.add(new Image(display, data));
        }

        return images;
    }
}

Phillipus · 2022-06-01T13:30:33Z

Strange, now I am able to reproduce this with scaling at 100%:

niraj-modi · 2022-06-01T13:49:44Z

Interestingly problem is seen only with second run onward irrespective of zoom.
Even got it working with 200% as well:

Revised steps to reproduce the issue with test-snippet:

Switch the Windows Display zoom 100% to 200%(or visa versa)
Run the test-snippet, it will works on either zoom.
Close it and relaunch, problem is seen.

tmssngr · 2022-06-01T14:18:18Z

Just for the records: my 4k monitor (main screen) has 175% scaling, the notebook display (second screen) 125% scaling.

Phillipus · 2022-06-01T14:57:37Z

I tried to narrow it down to loading an icon from file, but couldn't reproduce it other than the icons returned from Program.getImageData(). Perhaps there is something in the way that ImageData is created there that was missed in https://bugs.eclipse.org/bugs/show_bug.cgi?id=493455

Phillipus · 2022-06-01T15:05:28Z

As an experiment I changed line 366 of org.eclipse.swt.program.Program from:

int flags = OS.SHGFI_ICON | OS.SHGFI_SMALLICON | OS.SHGFI_USEFILEATTRIBUTES;

to:

int flags = OS.SHGFI_SMALLICON | OS.SHGFI_USEFILEATTRIBUTES;

And the icons are rendered OK.

Might be a clue?

Phillipus · 2022-06-01T17:40:02Z

This issue does manifest in Eclipse 4.24 Preferences:

Icons are rendered correctly in Eclipse 4.23:

niraj-modi · 2022-06-02T07:05:48Z

As an experiment I changed line 366 of org.eclipse.swt.program.Program from:

int flags = OS.SHGFI_ICON | OS.SHGFI_SMALLICON | OS.SHGFI_USEFILEATTRIBUTES;

to:

int flags = OS.SHGFI_SMALLICON | OS.SHGFI_USEFILEATTRIBUTES;

And the icons are rendered OK.

Might be a clue?

With above suggested changes the transparent background issue is addressed but the size of icons is coming too small and also seems blurred:

Phillipus · 2022-06-02T08:04:37Z

With above suggested changes the transparent background issue is addressed but the size of icons is coming too small and also seems blurred:

Yes. I was just looking for a clue.

It seems that the problem lies somewhere in the changes that were made as part of https://bugs.eclipse.org/bugs/show_bug.cgi?id=493455 Still seems to be some outstanding/unknown issues with this major change.

Phillipus · 2022-06-02T08:36:32Z

I don't think it's related to HiDPI. I'm seeing it on normal 100% scaling all the time now. See #185 (comment)

Phillipus · 2022-06-02T12:49:35Z

I've isolated the problem to some *.ico files. Nothing to do with Program.getImageData or HiDPI. So this regression will affect Eclipse and RCP apps that are displaying images in the Windows *ico format.

Attached is a reproducible snippet and icon file.

Here's how it should look running on Eclipse 4.23:

Here's how it looks on Eclipse 4.24:

ImageTest.zip

Phillipus · 2022-06-02T14:23:25Z

changed the title [HiDPI] Program.getImageData returns images with black background on Windows 10 GC#drawIcon draws *.ico(for some icons) with black background on Windows 10

GC#drawImage

lshanmug · 2022-06-02T16:12:41Z

Thanks Phil for investigating and narrowing down the issue!

jonathan-meier · 2022-06-02T20:34:51Z

The problem is here

eclipse.platform.swt/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java

Lines 1800 to 1803 in 6f2f07c

    
           case 32: 
        
           	newDepth = 24; 
        
           	newPalette = new PaletteData(0xFF, 0xFF00, 0xFF0000); 
        
           	break;

In commit 22797d3 I changed this from

case 32:
	if (!(redMask == 0xFF00 && greenMask == 0xFF0000 && blueMask == 0xFF000000)) {
		newPalette = new PaletteData(0xFF00, 0xFF0000, 0xFF000000);
	}
	break;

enforcing that any alpha data for an image must be provided via the ImageData.alphaData field and any alpha data in the fourth channel of the ImageData.data field for 32-bit images is strictly ignored. I did this to align the win32 implementation with the gtk implementation of Image, however, I forgot to consider the special case of icons (loaded from ICO files) that provide a 32-bit image and a mask.

For such icons, retrieving their ImageData via Image.getImageData (this is used inside Program.getImageData) does not populate the ImageData.alphaData field, even though the fourth channel of the image data contains valid alpha data and therefore, the alpha data is discarded when again creating an Image from this ImageData.

This becomes a problem for icons that do not use the color black for transparent pixels. Masked pixels colored in black become transparent, whereas masked pixels colored in any other color are XORed with their background color by GDI, which means that a masked pixel colored in white inverts its background color. This is exactly what happens in all examples provided above, where the white background is inverted to black by masked pixels colored in white. It happens only with a few icons, since most icons use the color black for transparent pixels.

Using the following method, you can color all masked pixels black to work around this issue:

private static void maskColor(ImageData imageData) {
	byte[] maskData = imageData.maskData;
	if (maskData == null || imageData.depth != 32) {
		return;
	}

	byte[] data = imageData.data;
	int stride = maskData.length / imageData.height;
	for (int i = 0, dp = 0, mbp = 0; i < imageData.height; i++, mbp += stride) {
		for (int j = 0, mp = mbp; j < imageData.width; mp++) {
			for (int b = 7; b >= 0 && j < imageData.width; b--, j++, dp++) {
				int mask = (maskData[mp] >> b) & 0x1;
				for (int c = 0; c < 3; c++, dp++) {
					data[dp] = (byte) (data[dp] * mask);
				}
			}
		}
	}
}

This still does not fix partially transparent pixels which are just drawn fully opaque when discarding the alpha channel, but this is much less visible and icons using partially transparent pixels are less common.

I will provide a PR with a fix for this issue as soon as possible. Thanks everyone for providing insights helping debug this issue 👍

Phillipus · 2022-06-16T09:43:37Z

I will provide a PR with a fix for this issue as soon as possible. Thanks everyone for providing insights helping debug this issue

@jonathan-meier Hi, did you find some time to implement a PR? Happy to test it if required. 👍

tmssngr · 2022-07-01T08:21:00Z

@jonathan-meier Unfortunately, your maskColor method doesn't resolve the problem for me (Windows 10).

Phillipus · 2022-07-05T09:01:31Z

This is reproducible with the latest SWT built from source (v4952r11). With bisecting I've found out that commit 22797d3 Revert "Revert "Bug 493455 - [win32] remove alpha and alphaData from Image"" introduced this bug.

@tmssngr Do you think if we reverted this, it would solve the regression?

tmssngr · 2022-07-05T11:55:25Z

I've tried reverting e891658, 819a24e, def5c63 and 22797d3, but then it did not compile any more because of a missing hDC in Image. Because I'm not an expert in the internals, I've aborted my tests.

tmssngr · 2022-07-07T08:14:07Z

I really would appreciate it if this obvious regression could be fixed soon.

Phillipus · 2022-07-07T09:34:51Z

I really would appreciate it if this obvious regression could be fixed soon.

@jonathan-meier Hi Jonathan, do you think it is possible to fix this regression?

niraj-modi · 2022-07-07T12:51:29Z

The problem is here

eclipse.platform.swt/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java

Lines 1800 to 1803 in 6f2f07c

case 32:

newDepth = 24;

newPalette = new PaletteData(0xFF, 0xFF00, 0xFF0000);

break;

In commit 22797d3 I changed this from
case 32:
	if (!(redMask == 0xFF00 && greenMask == 0xFF0000 && blueMask == 0xFF000000)) {
		newPalette = new PaletteData(0xFF00, 0xFF0000, 0xFF000000);
	}
	break;

Based on above input, I have a working fix for this issue:

Will share a PR for testing shortly.

Windows10 - Fixes eclipse-platform#185 Change-Id: Idec2ddb0086a58c8d28c7616a628e2802d06ce56 Signed-off-by: Niraj Modi <niraj.modi@in.ibm.com>

Phillipus · 2022-07-07T13:00:19Z

@niraj-modi Hi Niraj, thanks for taking a look at this. I tested your patch with the example case in #185 (comment) and I can confirm it seems to fix the problem.

Windows10 - Fixes #185 Change-Id: Idec2ddb0086a58c8d28c7616a628e2802d06ce56 Signed-off-by: Niraj Modi <niraj.modi@in.ibm.com>

tmssngr · 2022-07-11T12:18:16Z

Thanks for the fix.

sravanlakkimsetti added the Windows Happens on Windows OS label Jun 1, 2022

lshanmug added the regression Something that used to work label Jun 1, 2022

niraj-modi changed the title ~~Program.getImageData returns images with black background on Windows 10~~ [HiDPI] Program.getImageData returns images with black background on Windows 10 Jun 1, 2022

lshanmug added the HiDPI Issues related to High resolution monitors label Jun 2, 2022

niraj-modi changed the title ~~[HiDPI] Program.getImageData returns images with black background on Windows 10~~ GC#drawIcon draws *.ico(for some icons) with black background on Windows 10 Jun 2, 2022

niraj-modi removed the HiDPI Issues related to High resolution monitors label Jun 2, 2022

niraj-modi mentioned this issue Jul 7, 2022

GC#drawIcon draws *.ico(for some icons) with black background on Windows10 #244

Merged

niraj-modi closed this as completed in #244 Jul 11, 2022

niraj-modi added a commit that referenced this issue Jul 11, 2022

GC#drawIcon draws *.ico(for some icons) with black background on

8def011

Windows10 - Fixes #185 Change-Id: Idec2ddb0086a58c8d28c7616a628e2802d06ce56 Signed-off-by: Niraj Modi <niraj.modi@in.ibm.com>

niraj-modi self-assigned this Jul 11, 2022

niraj-modi added this to the 4.25 M2 milestone Jul 11, 2022

Phillipus mentioned this issue Aug 9, 2022

Regression drawing image arising from fix to #185 and other regressions in Image class #301

Closed

niraj-modi added the fix verified The implemented fix has been verified with an I-build label Aug 17, 2022

This was referenced Jun 29, 2023

[Windows Hi-DPI] Progress icon is too big and clipped #706

Open

[Windows Hi-DPI] Program icons have black background #715

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GC#drawIcon draws *.ico(for some icons) with black background on Windows 10 #185

GC#drawIcon draws *.ico(for some icons) with black background on Windows 10 #185

tmssngr commented Jun 1, 2022

iloveeclipse commented Jun 1, 2022

tmssngr commented Jun 1, 2022

niraj-modi commented Jun 1, 2022

niraj-modi commented Jun 1, 2022

Phillipus commented Jun 1, 2022 •

edited

niraj-modi commented Jun 1, 2022

Phillipus commented Jun 1, 2022 •

edited

Phillipus commented Jun 1, 2022 •

edited

niraj-modi commented Jun 1, 2022

Phillipus commented Jun 1, 2022 •

edited

Phillipus commented Jun 1, 2022

niraj-modi commented Jun 1, 2022 •

edited

tmssngr commented Jun 1, 2022

Phillipus commented Jun 1, 2022

Phillipus commented Jun 1, 2022 •

edited by niraj-modi

Phillipus commented Jun 1, 2022 •

edited

niraj-modi commented Jun 2, 2022

Phillipus commented Jun 2, 2022

Phillipus commented Jun 2, 2022

Phillipus commented Jun 2, 2022 •

edited

Phillipus commented Jun 2, 2022

lshanmug commented Jun 2, 2022

jonathan-meier commented Jun 2, 2022

Phillipus commented Jun 16, 2022 •

edited

tmssngr commented Jul 1, 2022

Phillipus commented Jul 5, 2022

tmssngr commented Jul 5, 2022

tmssngr commented Jul 7, 2022

Phillipus commented Jul 7, 2022

niraj-modi commented Jul 7, 2022

Phillipus commented Jul 7, 2022

tmssngr commented Jul 11, 2022

GC#drawIcon draws *.ico(for some icons) with black background on Windows 10 #185

GC#drawIcon draws *.ico(for some icons) with black background on Windows 10 #185

Comments

tmssngr commented Jun 1, 2022

iloveeclipse commented Jun 1, 2022

tmssngr commented Jun 1, 2022

niraj-modi commented Jun 1, 2022

niraj-modi commented Jun 1, 2022

Phillipus commented Jun 1, 2022 • edited

niraj-modi commented Jun 1, 2022

Phillipus commented Jun 1, 2022 • edited

Phillipus commented Jun 1, 2022 • edited

niraj-modi commented Jun 1, 2022

Phillipus commented Jun 1, 2022 • edited

Phillipus commented Jun 1, 2022

niraj-modi commented Jun 1, 2022 • edited

tmssngr commented Jun 1, 2022

Phillipus commented Jun 1, 2022

Phillipus commented Jun 1, 2022 • edited by niraj-modi

Phillipus commented Jun 1, 2022 • edited

niraj-modi commented Jun 2, 2022

Phillipus commented Jun 2, 2022

Phillipus commented Jun 2, 2022

Phillipus commented Jun 2, 2022 • edited

Phillipus commented Jun 2, 2022

lshanmug commented Jun 2, 2022

jonathan-meier commented Jun 2, 2022

Phillipus commented Jun 16, 2022 • edited

tmssngr commented Jul 1, 2022

Phillipus commented Jul 5, 2022

tmssngr commented Jul 5, 2022

tmssngr commented Jul 7, 2022

Phillipus commented Jul 7, 2022

niraj-modi commented Jul 7, 2022

Phillipus commented Jul 7, 2022

tmssngr commented Jul 11, 2022

Phillipus commented Jun 1, 2022 •

edited

Phillipus commented Jun 1, 2022 •

edited

Phillipus commented Jun 1, 2022 •

edited

Phillipus commented Jun 1, 2022 •

edited

niraj-modi commented Jun 1, 2022 •

edited

Phillipus commented Jun 1, 2022 •

edited by niraj-modi

Phillipus commented Jun 1, 2022 •

edited

Phillipus commented Jun 2, 2022 •

edited

Phillipus commented Jun 16, 2022 •

edited