Enum ImageFunctions

java.lang.Object

java.lang.Enum<ImageFunctions>

com.blackrook.rookscript.desktop.functions.ImageFunctions

All Implemented Interfaces:

com.blackrook.rookscript.lang.ScriptFunctionType, Serializable, Comparable<ImageFunctions>

public enum ImageFunctions
extends Enum<ImageFunctions>
implements com.blackrook.rookscript.lang.ScriptFunctionType

Script functions for image manipulation.

Author:

Matthew Tropiano

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImageFunctions.AdditiveComposite	A composite that adds pixel color together.
static class	ImageFunctions.AdditiveCompositeContext	The composite context for ImageFunctions.AdditiveComposites.
static enum	ImageFunctions.CompositingTypes	Compositing types.
static final class	ImageFunctions.DesaturationComposite	A composite that multiplies pixel color together.
static class	ImageFunctions.DesaturationCompositeContext	The composite context for ImageFunctions.DesaturationComposites.
static final class	ImageFunctions.MultiplicativeComposite	A composite that multiplies pixel color together.
static class	ImageFunctions.MultiplicativeCompositeContext	The composite context for ImageFunctions.MultiplicativeComposites.
static enum	ImageFunctions.ResamplingType	Resampling types.
static final class	ImageFunctions.SubtractiveComposite	A composite that subtracts pixel color.
static class	ImageFunctions.SubtractiveCompositeContext	The composite context for ImageFunctions.SubtractiveComposites.

Nested classes/interfaces inherited from interface com.blackrook.rookscript.lang.ScriptFunctionType

com.blackrook.rookscript.lang.ScriptFunctionType.Usage

Enum Constant Summary

Enum Constants

Enum Constant	Description
IMAGE
IMAGECOPY
IMAGECROP
IMAGEDRAW
IMAGEFILL
IMAGEFLIPH
IMAGEFLIPV
IMAGEGET
IMAGEHEIGHT
IMAGEPAINT
IMAGEREAD
IMAGERESIZE
IMAGESCALE
IMAGESET
IMAGETRANSPOSE
IMAGEWIDTH
IMAGEWRITE

Method Summary

Modifier and Type	Method	Description
static final com.blackrook.rookscript.resolvers.ScriptFunctionResolver	createResolver()
abstract boolean	execute(com.blackrook.rookscript.ScriptInstance scriptInstance, com.blackrook.rookscript.ScriptValue returnValue)
int	getParameterCount()
com.blackrook.rookscript.lang.ScriptFunctionType.Usage	getUsage()
protected abstract com.blackrook.rookscript.lang.ScriptFunctionType.Usage	usage()
static ImageFunctions	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ImageFunctions[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.blackrook.rookscript.lang.ScriptFunctionType

name

Enum Constant Details

IMAGE

public static final ImageFunctions IMAGE

IMAGEREAD

public static final ImageFunctions IMAGEREAD

IMAGEWRITE

public static final ImageFunctions IMAGEWRITE

IMAGECOPY

public static final ImageFunctions IMAGECOPY

IMAGERESIZE

public static final ImageFunctions IMAGERESIZE

IMAGESCALE

public static final ImageFunctions IMAGESCALE

IMAGECROP

public static final ImageFunctions IMAGECROP

IMAGEFLIPH

public static final ImageFunctions IMAGEFLIPH

IMAGEFLIPV

public static final ImageFunctions IMAGEFLIPV

IMAGETRANSPOSE

public static final ImageFunctions IMAGETRANSPOSE

IMAGEFILL

public static final ImageFunctions IMAGEFILL

IMAGEPAINT

public static final ImageFunctions IMAGEPAINT

IMAGEDRAW

public static final ImageFunctions IMAGEDRAW

Since:

1.10.2.1

IMAGESET

public static final ImageFunctions IMAGESET

IMAGEGET

public static final ImageFunctions IMAGEGET

IMAGEWIDTH

public static final ImageFunctions IMAGEWIDTH

IMAGEHEIGHT

public static final ImageFunctions IMAGEHEIGHT

Method Details

values

public static ImageFunctions[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ImageFunctions valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

createResolver

public static final com.blackrook.rookscript.resolvers.ScriptFunctionResolver createResolver()

Returns:

a function resolver that handles all of the functions in this enum.

getParameterCount

public int getParameterCount()

Specified by:

getParameterCount in interface com.blackrook.rookscript.lang.ScriptFunctionType

getUsage

public com.blackrook.rookscript.lang.ScriptFunctionType.Usage getUsage()

Specified by:

getUsage in interface com.blackrook.rookscript.lang.ScriptFunctionType

execute

public abstract boolean execute(com.blackrook.rookscript.ScriptInstance scriptInstance,
 com.blackrook.rookscript.ScriptValue returnValue)

Specified by:

execute in interface com.blackrook.rookscript.lang.ScriptFunctionType

usage

protected abstract com.blackrook.rookscript.lang.ScriptFunctionType.Usage usage()