Skip to content

[GTK] Stop decoding the image file on every draw at zoom != 100 - #3510

Open
vogella wants to merge 1 commit into
eclipse-platform:masterfrom
vogella:perf/drawimage-getimagedata
Open

[GTK] Stop decoding the image file on every draw at zoom != 100#3510
vogella wants to merge 1 commit into
eclipse-platform:masterfrom
vogella:perf/drawimage-getimagedata

Conversation

@vogella

@vogella vogella commented Aug 13, 2026

Copy link
Copy Markdown
Contributor

The internal drawImage that every public overload funnels into read the source dimensions from srcImage.getImageData(), which is getImageData(100).
At a device zoom other than 100 that misses the fast path and does new ImageData(fileName), a full open and decode of the image file, for SVG a full re-parse and re-rasterize, just to obtain two integers the Image already knows.
An ImageGcDrawer image paid the same way, by running the drawer callback once per draw.
Taking the dimensions from the Image removes that, with a fallback for images wrapped around a native handle by Image.gtk_new, which carry none and have no provider, so the fallback reads the in-memory cairo surface and never a file.

Measured with strace -f -e trace=openat over 100 draws of one Image at zoom 200, opens per draw fall from 1.00 to 0.00 for the 9 argument overload and from 2.00 to 1.00 for the 5 argument one; the remaining open there is the CachedImageAtSize path of #3505, addressed separately in #3506.
Cocoa already takes its dimensions from NSImage.size() and win32 from getBounds(), so this brings GTK in line with both.

Two cases change behavior, both where getBounds() and getImageData() already disagreed, and in both the new value is the one that agrees with getBounds().
A non-proportional asset set (16 pixels at 100%, 33 at 200%) now paints the last point row and column that were previously clipped, and a provider handing out the same file at every zoom now validates the source rectangle against the bounds, so passing getImageData() dimensions there raises ERROR_INVALID_ARGUMENT where it previously drew.
Everything else renders identically, verified as matching SHA-256 of the drawn ImageData across both overloads, three files and zoom 100, 150 and 200.

The new test deletes the image file after the first draw, so any further read fails loudly; it was confirmed to fail before the change and pass after.
It runs on all platforms although the fix is GTK only, so the win32 and macOS workflow results are worth a look rather than a rubber stamp.

Fixes #3507

The internal drawImage that every public overload funnels into read the
source dimensions from srcImage.getImageData(), which is getImageData(100).
At currentDeviceZoom != 100 that misses the zoom == currentDeviceZoom fast
path and loads new ImageData(fileName): a full open and full decode, for
SVG a full re-parse and re-rasterize, to obtain two integers the Image
already knows. The result was used for nothing else, the drawing itself
goes through srcImage.surface. An ImageGcDrawer image paid the same way,
by running the drawer callback once per draw.

Take the dimensions from the Image, falling back to ImageData for images
wrapped around a native handle by Image.gtk_new, which carry none. Those
have no provider, so the fallback reads the cairo surface and never a
file. Cocoa already takes its dimensions from NSImage.size() and win32
from getBounds(), so this brings GTK in line with both.

Opens per draw over 100 draws of one Image at zoom 200, strace on
Linux/GTK:

  9 arg overload, PNG    1.00 -> 0.00
  5 arg overload, PNG    2.00 -> 1.00

The open left on the 5 arg overload is the CachedImageAtSize path of
issue 3505.

Rendering is unchanged wherever the Image dimensions agree with the
decoded ones, verified as identical SHA-256 of the drawn ImageData over
both overloads, three files and zoom 100, 150 and 200, and again for an
ImageFileNameProvider returning one path at every zoom.

Two cases change, both where getBounds() and getImageData() already
disagreed. For an asset set that is not exactly proportional, 16 pixels
at 100% and 33 at 200%, the width field is round(33/2) = 17 while
getImageData(100) gives 16, so at zoom 200 the unscaled draw now paints
the last point row and column that were previously clipped. For a
provider handing out the same file at every zoom, a 16 pixel file at zoom
200 gives bounds 8 and getImageData 16, so passing getImageData()
dimensions as the source rectangle now raises ERROR_INVALID_ARGUMENT
where it previously drew. In both cases the new value is the one that
agrees with getBounds().

Fixes eclipse-platform#3507
@github-actions

Copy link
Copy Markdown
Contributor

Test Results

  211 files   -  1    211 suites   - 1   27m 10s ⏱️ - 1m 17s
4 838 tests  - 56  4 816 ✅  - 54   21 💤  - 3  0 ❌ ±0  1 🔥 +1 
7 014 runs   - 51  6 848 ✅  - 49  165 💤  - 3  0 ❌ ±0  1 🔥 +1 

For more details on these errors, see this check.

Results for commit 3443bc6. ± Comparison against base commit 9ca368d.

This pull request removes 57 and adds 1 tests. Note that renamed tests count towards both.
org.eclipse.swt.graphics.ImageWin32Tests ‑ testDisposeDrawnImageBeforeRequestingTargetForOtherZoom
org.eclipse.swt.graphics.ImageWin32Tests ‑ testDrawImageAtDifferentZooms(boolean)[1] true
org.eclipse.swt.graphics.ImageWin32Tests ‑ testDrawImageAtDifferentZooms(boolean)[2] false
org.eclipse.swt.graphics.ImageWin32Tests ‑ testImageDataForDifferentFractionalZoomsShouldBeDifferent
org.eclipse.swt.graphics.ImageWin32Tests ‑ testImageShouldHaveDimesionAsPerZoomLevel
org.eclipse.swt.graphics.ImageWin32Tests ‑ testRetrieveImageDataAtDifferentZooms(boolean)[1] true
org.eclipse.swt.graphics.ImageWin32Tests ‑ testRetrieveImageDataAtDifferentZooms(boolean)[2] false
org.eclipse.swt.graphics.ImageWin32Tests ‑ test_getImageData_fromCopiedImage
org.eclipse.swt.graphics.ImageWin32Tests ‑ test_getImageData_fromImageForImageDataFromImage
org.eclipse.swt.tests.win32.Test_org_eclipse_swt_dnd_DND ‑ testByteArrayTransfer
…
org.eclipse.swt.tests.junit.Test_org_eclipse_swt_graphics_GC ‑ test_drawImage_doesNotReReadImageFileAtNonDefaultZoom

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

GC.drawImage fully decodes the image file on every draw at zoom != 100

1 participant