The built-in KeyImage.Black does not always work

[wojciechsura]

Occasionally, when button image is replaced with KeyImage.Black, it does not get replaced at all, leaving images from previous screen. This happens when all buttons are replaced in sequence (e.g. when switching the whole screen to a different one).

Workaround: create a black (e.g.) 72x72 image manually and pass it instead of KeyImage.Black.

[wischi-chr]

Can you post a code snippet to reproduce that behavior?

[wojciechsura]

Again, I don't have short code, but you may reproduce it in my project.

• Clone https://gitlab.com/spook/OpenMacroKeyboard.git
• Switch to commit f4a107dd9c2d12524177013569a0eb21b5788455
• In the Driver.cs file you may notice the following code:

        public override void UpdateVisuals(List<KeyboardElementVisuals> buttons, List<KeyboardElementVisuals> encoders)
        {
            if (deck == null)
                return;

            if (sleep)
            {
                deck.SetBrightness(brightness);
                sleep = false;
            }

            // Prepare images to display            

            for (int i = 0; i < buttons.Count; i++)
            {
                RawImage? image = buttons[i].CustomCache as RawImage;
                if (image != null)
                    deck.SetKeyBitmap(i, KeyBitmap.Create.FromBgra32Array(image.Width, image.Height, image.Argb));
                else
                    deck.SetKeyBitmap(i, KeyBitmap.Black);
            }
        }

The last line sets the image of a button to black if there is no image set by the user.

• Rebuild whole solution (important!)
• Start the application
• Add a Stream Deck keyboard
• Configure layout
• Add some images to buttons (may be the same)
• Make one button a folder (drag the folder macro from the list onto the button)
• Add some (different) images to buttons in the folder
• Confirm layout
• Use the Stream Deck to open the folder and close it multiple times. The bug should manifest itself by buttons not being cleared every time (in my case it happened roughly once for 3-4 attempts).