Package com.intellij.util.ui

Class ImageUtil

java.lang.Object

com.intellij.util.ui.ImageUtil

public final class ImageUtil
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ImageUtil()

Method Summary

Modifier and Type	Method and Description
static java.awt.image.BufferedImage	createImage(java.awt.GraphicsConfiguration gc, int width, int height, int type) Creates a HiDPI-aware BufferedImage in the graphics config scale.
static java.awt.image.BufferedImage	createImage(java.awt.Graphics g, double width, double height, int type, PaintUtil.RoundingMode rm)
static java.awt.image.BufferedImage	createImage(java.awt.Graphics g, int width, int height, int type) Creates a HiDPI-aware BufferedImage in the graphics device scale.
static java.awt.image.BufferedImage	createImage(int width, int height, int type) Creates a HiDPI-aware BufferedImage in device scale.
static java.awt.Image	ensureHiDPI(java.awt.Image image, JBUI.ScaleContext ctx) Deprecated. Use ensureHiDPI(Image, ScaleContext).
static java.awt.Image	ensureHiDPI(java.awt.Image image, ScaleContext ctx) Wraps the image with JBHiDPIScaledImage according to ctx when applicable.
static java.awt.Image	ensureHiDPI(java.awt.Image image, ScaleContext ctx, double userWidth, double userHeight) Wraps the image with JBHiDPIScaledImage according to ctx when applicable.
static java.awt.Image	filter(java.awt.Image image, java.awt.image.ImageFilter filter)
static double	getImageScale(java.awt.Image image)
static int	getRealHeight(java.awt.Image image)
static int	getRealWidth(java.awt.Image image)
static int	getUserHeight(java.awt.Image image)
static int	getUserWidth(java.awt.Image image)
static java.awt.Image	scaleImage(java.awt.Image image, double scale) Scales the image taking into account its HiDPI awareness.
static java.awt.Image	scaleImage(java.awt.Image image, int width, int height) Scales the image taking into account its HiDPI awareness.
static java.awt.image.BufferedImage	toBufferedImage(java.awt.Image image)
static java.awt.image.BufferedImage	toBufferedImage(java.awt.Image image, boolean inUserSize)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImageUtil

public ImageUtil()

Method Detail

createImage

public static java.awt.image.BufferedImage createImage(int width,
                                                       int height,
                                                       int type)

Creates a HiDPI-aware BufferedImage in device scale.

Parameters:

width - the width in user coordinate space

height - the height in user coordinate space

type - the type of the image

Returns:

a HiDPI-aware BufferedImage in device scale

Throws:

java.lang.IllegalArgumentException - if width or height is not greater than 0

createImage

public static java.awt.image.BufferedImage createImage(java.awt.GraphicsConfiguration gc,
                                                       int width,
                                                       int height,
                                                       int type)

Creates a HiDPI-aware BufferedImage in the graphics config scale.

Parameters:

gc - the graphics config

width - the width in user coordinate space

height - the height in user coordinate space

type - the type of the image

Returns:

a HiDPI-aware BufferedImage in the graphics scale

Throws:

java.lang.IllegalArgumentException - if width or height is not greater than 0

createImage

public static java.awt.image.BufferedImage createImage(java.awt.Graphics g,
                                                       int width,
                                                       int height,
                                                       int type)

Creates a HiDPI-aware BufferedImage in the graphics device scale.

Parameters:

g - the graphics of the target device

width - the width in user coordinate space

height - the height in user coordinate space

type - the type of the image

Returns:

a HiDPI-aware BufferedImage in the graphics scale

Throws:

java.lang.IllegalArgumentException - if width or height is not greater than 0

createImage

public static java.awt.image.BufferedImage createImage(java.awt.Graphics g,
                                                       double width,
                                                       double height,
                                                       int type,
                                                       PaintUtil.RoundingMode rm)

Throws:

java.lang.IllegalArgumentException - if width or height is not greater than 0

See Also:

#createImage(GraphicsConfiguration, double, double, int, PaintUtil.RoundingMode)

toBufferedImage

public static java.awt.image.BufferedImage toBufferedImage(java.awt.Image image)

toBufferedImage

public static java.awt.image.BufferedImage toBufferedImage(java.awt.Image image,
                                                           boolean inUserSize)

getImageScale

public static double getImageScale(java.awt.Image image)

getRealWidth

public static int getRealWidth(java.awt.Image image)

getRealHeight

public static int getRealHeight(java.awt.Image image)

getUserWidth

public static int getUserWidth(java.awt.Image image)

getUserHeight

public static int getUserHeight(java.awt.Image image)

filter

public static java.awt.Image filter(java.awt.Image image,
                                    java.awt.image.ImageFilter filter)

scaleImage

public static java.awt.Image scaleImage(java.awt.Image image,
                                        double scale)

Scales the image taking into account its HiDPI awareness.

scaleImage

public static java.awt.Image scaleImage(java.awt.Image image,
                                        int width,
                                        int height)

Scales the image taking into account its HiDPI awareness.

Parameters:

width - target user width

height - target user height

ensureHiDPI

public static java.awt.Image ensureHiDPI(java.awt.Image image,
                                         ScaleContext ctx)

Wraps the image with JBHiDPIScaledImage according to ctx when applicable.

ensureHiDPI

@Deprecated
public static java.awt.Image ensureHiDPI(java.awt.Image image,
                                         JBUI.ScaleContext ctx)

Deprecated. Use ensureHiDPI(Image, ScaleContext).

ensureHiDPI

public static java.awt.Image ensureHiDPI(java.awt.Image image,
                                         ScaleContext ctx,
                                         double userWidth,
                                         double userHeight)

Wraps the image with JBHiDPIScaledImage according to ctx when applicable. The real (dev) width/height of the provided image is usually calculated based on the scale context and the expected user width/height of the target wrapped image. In the ensureHiDPI(Image, ScaleContext) method version, the expected user width/height of the wrapped image is reconstructed from the image's real width/height and the scale context. However, the real with/height may lose precision (as it is integer) and as the result the reconstructed user width/height may differ from the original values. To avoid the loss this method version accepts the original user width/height.

Parameters:

image - the raw image to wrap

ctx - the scale context to match

userWidth - the expected user width of the wrapped image

userHeight - the expected user height of the wrapped image