libGDX 1.14.2 · com.badlogic.gdx.tools.distancefield.DistanceFieldGenerator

Modifier and Type	Class and Description
private static class	DistanceFieldGenerator.CommandLineArgumentException Thrown when the command line contained nonsense.

Modifier and Type	Field and Description
private Color	color
private int	downscale
private float	spread

Access	Constructor and Description
public	DistanceFieldGenerator()

Method Summary

Modifier and Type	Method and Description
private int	Returns: an ARGB color value suitable for `BufferedImage#setRGB`. distanceToRGB(float the signed distance of a pixel signedDistance) For a distance as returned by `findSignedDistance`, returns the corresponding "RGB" (really ARGB) color value.
private float	Returns: the signed distance findSignedDistance(final int the x coordinate of the center point centerX, final int the y coordinate of the center point centerY, boolean[][] the array representation of an image, `true` representing "inside" bitmap) Returns the signed distance for a given point.
public BufferedImage	Returns: the distance field image generateDistanceField(BufferedImage the image to process. inImage) Process the image into a distance field.
public Color	getColor()
public int	getDownscale()
public float	getSpread()
private boolean	isInside(int rgb) Returns `true` if the color is considered as the "inside" of the image, `false` if considered "outside".
public static void	main(String[] command line arguments args) Main function to run the generator as a standalone program.
private static void	run(String[] command line arguments args) Runs the program.
public void	setColor(Color color) Sets the color to be used for the output image.
public void	setDownscale(int a positive integer downscale) Sets the factor by which to downscale the image during processing.
public void	setSpread(float a positive number spread) Sets the spread of the distance field.
private static int	Returns: The squared distance between the two points squareDist(final int The x coordinate of the first point x1, final int The y coordiante of the first point y1, final int The x coordinate of the second point x2, final int The y coordinate of the second point y2) Caclulate the squared distance between two points
private static void	usage() Prints usage information to standard output.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

color	back to summary
private Color color

downscale	back to summary
private int downscale

spread	back to summary
private float spread

DistanceFieldGenerator	back to summary
public DistanceFieldGenerator()

Method Detail

distanceToRGB back to summary

distanceToRGB	back to summary
private int distanceToRGB(float signedDistance) For a distance as returned by `findSignedDistance`, returns the corresponding "RGB" (really ARGB) color value. Parameters signedDistance:float the signed distance of a pixel Returns:int an ARGB color value suitable for `BufferedImage#setRGB`.

private int distanceToRGB(float signedDistance)

For a distance as returned by findSignedDistance, returns the corresponding "RGB" (really ARGB) color value.

Parameters

signedDistance:float: the signed distance of a pixel

Returns:int

an ARGB color value suitable for BufferedImage#setRGB.

findSignedDistance back to summary

findSignedDistance	back to summary
private float findSignedDistance(final int centerX, final int centerY, boolean[][] bitmap) Returns the signed distance for a given point. For points "inside", this is the distance to the closest "outside" pixel. For points "outside", this is the negative distance to the closest "inside" pixel. If no pixel of different color is found within a radius of `spread`, returns the `-spread` or `spread`, respectively. Parameters centerX:int the x coordinate of the center point centerY:int the y coordinate of the center point bitmap:boolean[][] the array representation of an image, `true` representing "inside" Returns:float the signed distance

private float findSignedDistance(final int centerX, final int centerY, boolean[][] bitmap)

Returns the signed distance for a given point. For points "inside", this is the distance to the closest "outside" pixel. For points "outside", this is the negative distance to the closest "inside" pixel. If no pixel of different color is found within a radius of spread, returns the -spread or spread, respectively.

Parameters

centerX:int: the x coordinate of the center point
centerY:int: the y coordinate of the center point
bitmap:boolean[][]: the array representation of an image, true representing "inside"

Returns:float

the signed distance

generateDistanceField back to summary

generateDistanceField	back to summary
public BufferedImage generateDistanceField(BufferedImage inImage) Process the image into a distance field. The input image should be binary (black/white), but if not, see `isInside(int)`. The returned image is a factor of `upscale` smaller than `inImage`. Opaque pixels more than `spread` away in the output image from white remain opaque; transparent pixels more than `spread` away in the output image from black remain transparent. In between, we get a smooth transition from opaque to transparent, with an alpha value of 0.5 when we are exactly on the edge. Parameters inImage:BufferedImage the image to process. Returns:BufferedImage the distance field image

public BufferedImage generateDistanceField(BufferedImage inImage)

Process the image into a distance field. The input image should be binary (black/white), but if not, see isInside(int). The returned image is a factor of upscale smaller than inImage. Opaque pixels more than spread away in the output image from white remain opaque; transparent pixels more than spread away in the output image from black remain transparent. In between, we get a smooth transition from opaque to transparent, with an alpha value of 0.5 when we are exactly on the edge.

Parameters

inImage:BufferedImage: the image to process.

Returns:BufferedImage

the distance field image

getColor	back to summary
public Color getColor() See Also `setColor(Color)`

getDownscale	back to summary
public int getDownscale() See Also `setDownscale(int)`

getSpread	back to summary
public float getSpread() See Also `setSpread(float)`

isInside back to summary

isInside	back to summary
private boolean isInside(int rgb) Returns `true` if the color is considered as the "inside" of the image, `false` if considered "outside". Any color with one of its color channels at least 128 and its alpha channel at least 128 is considered "inside".

private boolean isInside(int rgb)

Returns true if the color is considered as the "inside" of the image, false if considered "outside".

Any color with one of its color channels at least 128 and its alpha channel at least 128 is considered "inside".

main back to summary

main	back to summary
public static void main(String[] args) Main function to run the generator as a standalone program. Run without arguments for usage instructions (or see `usage()`). Parameters args:String[] command line arguments

public static void main(String[] args)

Main function to run the generator as a standalone program. Run without arguments for usage instructions (or see usage()).

Parameters

args:String[]: command line arguments

run	back to summary
private static void run(String[] args) Runs the program. Parameters args:String[] command line arguments Exceptions CommandLineArgumentException: if the command line contains an error

run

back to summary

private static void run(String[] args)

Runs the program.

Parameters

args:String[]: command line arguments

Exceptions

CommandLineArgumentException:: if the command line contains an error

setColor	back to summary
public void setColor(Color color) Sets the color to be used for the output image. Its alpha component is ignored. Defaults to white, which is convenient for multiplying by a color value at runtime.

setDownscale	back to summary
public void setDownscale(int downscale) Sets the factor by which to downscale the image during processing. The output image will be smaller than the input image by this factor, rounded downwards. For greater accuracy, images to be used as input for a distance field are often generated at higher resolution. Parameters downscale:int a positive integer Exceptions IllegalArgumentException: if downscale is not positive

setDownscale

back to summary

public void setDownscale(int downscale)

Sets the factor by which to downscale the image during processing. The output image will be smaller than the input image by this factor, rounded downwards.

For greater accuracy, images to be used as input for a distance field are often generated at higher resolution.

Parameters

downscale:int: a positive integer

Exceptions

IllegalArgumentException:: if downscale is not positive

setSpread	back to summary
public void setSpread(float spread) Sets the spread of the distance field. The spread is the maximum distance in pixels that we'll scan while for a nearby edge. The resulting distance is also normalized by the spread. Parameters spread:float a positive number Exceptions IllegalArgumentException: if spread is not positive

setSpread

back to summary

public void setSpread(float spread)

Sets the spread of the distance field. The spread is the maximum distance in pixels that we'll scan while for a nearby edge. The resulting distance is also normalized by the spread.

Parameters

spread:float: a positive number

Exceptions

IllegalArgumentException:: if spread is not positive

squareDist	back to summary
private static int squareDist(final int x1, final int y1, final int x2, final int y2) Caclulate the squared distance between two points Parameters x1:int The x coordinate of the first point y1:int The y coordiante of the first point x2:int The x coordinate of the second point y2:int The y coordinate of the second point Returns:int The squared distance between the two points

squareDist

back to summary

private static int squareDist(final int x1, final int y1, final int x2, final int y2)

Caclulate the squared distance between two points

Parameters

x1:int: The x coordinate of the first point
y1:int: The y coordiante of the first point
x2:int: The x coordinate of the second point
y2:int: The y coordinate of the second point

Returns:int

The squared distance between the two points

usage	back to summary
private static void usage() Prints usage information to standard output.

public Class DistanceFieldGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class DistanceFieldGenerator.CommandLineArgumentException

Constructor Summary

Constructor Detail