forked from eclipse-platform/eclipse.platform.swt
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature Proposal: Rasterization of SVGs at Runtime for Eclipse Icons Fixes eclipse-platform#1438 Eclipse currently loads icons exclusively as raster graphics (e.g., `.png`), without support for vector formats like `.svg`. A major drawback of raster graphics is their inability to scale without degrading image quality. Additionally, generating icons of different sizes requires manually rasterizing SVGs outside Eclipse, leading to unnecessary effort and many icon files. This PR introduces support for vector graphics in Eclipse, enabling SVGs to be used for icons. Existing PNG icons will continue to be loaded alongside SVGs, allowing the use of the new functionality without the need to replace all PNG files at once. --- - **How It Works**: - To use SVG icons, simply place the SVG file in the bundle and reference it in the `plugin.xml` and other necessary locations, as is done for PNGs. No additional configuration is required. - At runtime, Eclipse uses the library JSVG to rasterize the SVG into a raster image of the desired size, eliminating the need for scaling. My analysis shows that JSVG is the most suitable Java library for this purpose. - You need to write the flag `-Dswt.autoScale=quarter` into your `eclipse.ini` file or into the run arguments of a new configuration.
- Loading branch information
1 parent
2ce8542
commit 09773d9
Showing
16 changed files
with
679 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<classpath> | ||
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-17"/> | ||
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/> | ||
<classpathentry kind="src" path="src"/> | ||
<classpathentry kind="lib" path="libs/jsvg-1.6.1.jar"/> | ||
<classpathentry kind="output" path="bin"/> | ||
</classpath> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<projectDescription> | ||
<name>org.eclipse.swt.svg</name> | ||
<comment></comment> | ||
<projects> | ||
</projects> | ||
<buildSpec> | ||
<buildCommand> | ||
<name>org.eclipse.jdt.core.javabuilder</name> | ||
<arguments> | ||
</arguments> | ||
</buildCommand> | ||
<buildCommand> | ||
<name>org.eclipse.pde.ManifestBuilder</name> | ||
<arguments> | ||
</arguments> | ||
</buildCommand> | ||
<buildCommand> | ||
<name>org.eclipse.pde.SchemaBuilder</name> | ||
<arguments> | ||
</arguments> | ||
</buildCommand> | ||
</buildSpec> | ||
<natures> | ||
<nature>org.eclipse.pde.PluginNature</nature> | ||
<nature>org.eclipse.jdt.core.javanature</nature> | ||
</natures> | ||
</projectDescription> |
2 changes: 2 additions & 0 deletions
2
bundles/org.eclipse.swt.svg/.settings/org.eclipse.core.resources.prefs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
eclipse.preferences.version=1 | ||
encoding/<project>=UTF-8 |
9 changes: 9 additions & 0 deletions
9
bundles/org.eclipse.swt.svg/.settings/org.eclipse.jdt.core.prefs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
eclipse.preferences.version=1 | ||
org.eclipse.jdt.core.compiler.codegen.targetPlatform=17 | ||
org.eclipse.jdt.core.compiler.compliance=17 | ||
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error | ||
org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled | ||
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error | ||
org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=warning | ||
org.eclipse.jdt.core.compiler.release=enabled | ||
org.eclipse.jdt.core.compiler.source=17 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
Manifest-Version: 1.0 | ||
Bundle-ManifestVersion: 2 | ||
Bundle-Name: SvgPlugin | ||
Bundle-SymbolicName: org.eclipse.swt.svg | ||
Bundle-Version: 1.0.0.qualifier | ||
Automatic-Module-Name: org.eclipse.swt.svgPlugin | ||
Bundle-RequiredExecutionEnvironment: JavaSE-17 | ||
Export-Package: org.eclipse.swt.svg | ||
Import-Package: org.eclipse.swt.graphics | ||
Bundle-ClassPath: ., libs/jsvg-1.6.1.jar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
source.. = src/ | ||
output.. = bin/ | ||
bin.includes = META-INF/,\ | ||
.,\ | ||
libs/jsvg-1.6.1.jar |
Binary file not shown.
176 changes: 176 additions & 0 deletions
176
bundles/org.eclipse.swt.svg/src/org/eclipse/swt/svg/JSVGRasterizer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,176 @@ | ||
/******************************************************************************* | ||
* Copyright (c) 2025 Vector Informatik GmbH and others. | ||
* | ||
* This program and the accompanying materials are made available under the terms of the Eclipse | ||
* Public License 2.0 which accompanies this distribution, and is available at | ||
* https://www.eclipse.org/legal/epl-2.0/ | ||
* | ||
* SPDX-License-Identifier: EPL-2.0 | ||
* | ||
* Contributors: Michael Bangas (Vector Informatik GmbH) - initial API and implementation | ||
*******************************************************************************/ | ||
package org.eclipse.swt.svg; | ||
|
||
import static java.awt.RenderingHints.*; | ||
|
||
import java.awt.*; | ||
import java.awt.image.*; | ||
import java.io.*; | ||
import java.util.*; | ||
import org.eclipse.swt.graphics.SVGRasterizer; | ||
import org.eclipse.swt.graphics.ImageData; | ||
import org.eclipse.swt.graphics.PaletteData; | ||
import org.eclipse.swt.graphics.RGB; | ||
import org.eclipse.swt.graphics.SVGRasterizerRegistry; | ||
|
||
import com.github.weisj.jsvg.*; | ||
import com.github.weisj.jsvg.geometry.size.*; | ||
import com.github.weisj.jsvg.parser.*; | ||
|
||
/** | ||
* A rasterizer implementation for converting SVG data into rasterized images. | ||
* This class implements the {@code ISVGRasterizer} interface. | ||
* | ||
* @since 1.0.0 | ||
*/ | ||
public class JSVGRasterizer implements SVGRasterizer { | ||
|
||
private SVGLoader svgLoader; | ||
|
||
/** | ||
* Initializes the SVG rasterizer by registering an instance of this rasterizer | ||
* with the {@link SVGRasterizerRegistry}. | ||
*/ | ||
public static void intializeJSVGRasterizer() { | ||
SVGRasterizerRegistry.register(new JSVGRasterizer()); | ||
} | ||
|
||
private final static Map<Key, Object> RENDERING_HINTS = Map.of(KEY_ANTIALIASING, VALUE_ANTIALIAS_ON, // | ||
KEY_ALPHA_INTERPOLATION, VALUE_ALPHA_INTERPOLATION_QUALITY, // | ||
KEY_COLOR_RENDERING, VALUE_COLOR_RENDER_QUALITY, // | ||
KEY_DITHERING, VALUE_DITHER_DISABLE, // | ||
KEY_FRACTIONALMETRICS, VALUE_FRACTIONALMETRICS_ON, // | ||
KEY_INTERPOLATION, VALUE_INTERPOLATION_BICUBIC, // | ||
KEY_RENDERING, VALUE_RENDER_QUALITY, // | ||
KEY_STROKE_CONTROL, VALUE_STROKE_PURE, // | ||
KEY_TEXT_ANTIALIASING, VALUE_TEXT_ANTIALIAS_ON // | ||
); | ||
|
||
@Override | ||
public ImageData rasterizeSVG(InputStream stream, float scalingFactor) throws IOException { | ||
if (stream == null) { | ||
throw new IllegalArgumentException("InputStream cannot be null"); | ||
} | ||
stream.mark(Integer.MAX_VALUE); | ||
if(svgLoader == null) { | ||
svgLoader = new SVGLoader(); | ||
} | ||
SVGDocument svgDocument = null; | ||
InputStream nonClosingStream = new FilterInputStream(stream) { | ||
@Override | ||
public void close() throws IOException { | ||
// Do nothing to prevent closing the underlying stream | ||
} | ||
}; | ||
svgDocument = svgLoader.load(nonClosingStream, null, LoaderContext.createDefault()); | ||
stream.reset(); | ||
if (svgDocument != null) { | ||
FloatSize size = svgDocument.size(); | ||
double originalWidth = size.getWidth(); | ||
double originalHeight = size.getHeight(); | ||
int scaledWidth = (int) Math.round(originalWidth * scalingFactor); | ||
int scaledHeight = (int) Math.round(originalHeight * scalingFactor); | ||
BufferedImage image = new BufferedImage(scaledWidth, scaledHeight, BufferedImage.TYPE_INT_ARGB); | ||
Graphics2D g = image.createGraphics(); | ||
g.setRenderingHints(RENDERING_HINTS); | ||
g.scale(scalingFactor, scalingFactor); | ||
svgDocument.render(null, g); | ||
g.dispose(); | ||
return convertToSWT(image); | ||
} | ||
return null; | ||
} | ||
|
||
private ImageData convertToSWT(BufferedImage bufferedImage) { | ||
if (bufferedImage.getColorModel() instanceof DirectColorModel) { | ||
DirectColorModel colorModel = (DirectColorModel)bufferedImage.getColorModel(); | ||
PaletteData palette = new PaletteData( | ||
colorModel.getRedMask(), | ||
colorModel.getGreenMask(), | ||
colorModel.getBlueMask()); | ||
ImageData data = new ImageData(bufferedImage.getWidth(), bufferedImage.getHeight(), | ||
colorModel.getPixelSize(), palette); | ||
for (int y = 0; y < data.height; y++) { | ||
for (int x = 0; x < data.width; x++) { | ||
int rgb = bufferedImage.getRGB(x, y); | ||
int pixel = palette.getPixel(new RGB((rgb >> 16) & 0xFF, (rgb >> 8) & 0xFF, rgb & 0xFF)); | ||
data.setPixel(x, y, pixel); | ||
if (colorModel.hasAlpha()) { | ||
data.setAlpha(x, y, (rgb >> 24) & 0xFF); | ||
} | ||
} | ||
} | ||
return data; | ||
} | ||
else if (bufferedImage.getColorModel() instanceof IndexColorModel) { | ||
IndexColorModel colorModel = (IndexColorModel)bufferedImage.getColorModel(); | ||
int size = colorModel.getMapSize(); | ||
byte[] reds = new byte[size]; | ||
byte[] greens = new byte[size]; | ||
byte[] blues = new byte[size]; | ||
colorModel.getReds(reds); | ||
colorModel.getGreens(greens); | ||
colorModel.getBlues(blues); | ||
RGB[] rgbs = new RGB[size]; | ||
for (int i = 0; i < rgbs.length; i++) { | ||
rgbs[i] = new RGB(reds[i] & 0xFF, greens[i] & 0xFF, blues[i] & 0xFF); | ||
} | ||
PaletteData palette = new PaletteData(rgbs); | ||
ImageData data = new ImageData(bufferedImage.getWidth(), bufferedImage.getHeight(), | ||
colorModel.getPixelSize(), palette); | ||
data.transparentPixel = colorModel.getTransparentPixel(); | ||
WritableRaster raster = bufferedImage.getRaster(); | ||
int[] pixelArray = new int[1]; | ||
for (int y = 0; y < data.height; y++) { | ||
for (int x = 0; x < data.width; x++) { | ||
raster.getPixel(x, y, pixelArray); | ||
data.setPixel(x, y, pixelArray[0]); | ||
} | ||
} | ||
return data; | ||
} | ||
else if (bufferedImage.getColorModel() instanceof ComponentColorModel) { | ||
ComponentColorModel colorModel = (ComponentColorModel)bufferedImage.getColorModel(); | ||
//ASSUMES: 3 BYTE BGR IMAGE TYPE | ||
PaletteData palette = new PaletteData(0x0000FF, 0x00FF00,0xFF0000); | ||
ImageData data = new ImageData(bufferedImage.getWidth(), bufferedImage.getHeight(), | ||
colorModel.getPixelSize(), palette); | ||
//This is valid because we are using a 3-byte Data model with no transparent pixels | ||
data.transparentPixel = -1; | ||
WritableRaster raster = bufferedImage.getRaster(); | ||
int[] pixelArray = new int[3]; | ||
for (int y = 0; y < data.height; y++) { | ||
for (int x = 0; x < data.width; x++) { | ||
raster.getPixel(x, y, pixelArray); | ||
int pixel = palette.getPixel(new RGB(pixelArray[0], pixelArray[1], pixelArray[2])); | ||
data.setPixel(x, y, pixel); | ||
} | ||
} | ||
return data; | ||
} | ||
return null; | ||
} | ||
|
||
public boolean isSVGFile(InputStream stream) throws IOException { | ||
if (stream == null) { | ||
throw new IllegalArgumentException("InputStream cannot be null"); | ||
} | ||
stream.mark(Integer.MAX_VALUE); | ||
try { | ||
int firstByte = stream.read(); | ||
return firstByte == '<'; | ||
} finally { | ||
stream.reset(); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.