Modifier and Type	Class and Description
public static enum	Renderer.RendererState Enumeration describing the lifecycle states of the renderer.

Modifier and Type	Field and Description
private final ImagePool	imagePool
private Map<String, EffectPeer<T extends RenderState>>	peerCache
private static final Map<FilterContext, Renderer>	rendererMap
public static final String	rootPkg
protected static final boolean	verbose

Access	Constructor and Description
protected	Renderer()

Method Summary

Modifier and Type	Method and Description
public abstract void	clearImage(Filterable the image to be cleared image) Mainly used by `ImagePool` for the purpose of clearing an image before handing it back to the user.
public abstract PoolFilterable	createCompatibleImage(int w, int h)
public LockableResource	createFloatTexture(int w, int h)
public abstract ImageData	Returns: a new `ImageData` createImageData(FilterContext the filter context fctx, Filterable src) Mainly used by the `Identity` effect for the purpose of creating a cached `ImageData` from the given platform-specific image (e.g. a `BufferedImage` wrapped in a `J2DImage`).
protected abstract EffectPeer<T extends RenderState>	Returns: new peer createPeer(FilterContext context shared with the renderer fctx, String of the peer name, int unroll count unrollCount) Creates a new peer given the context, name and unroll count.
public abstract Effect.AccelType	Returns: the `AccelType` used by typical peers of this renderer getAccelType() Returns the `AccelType` used by default for peers of this renderer.
protected abstract Renderer	Returns: backup renderer getBackupRenderer() Returns an instance of backup renderer to be used if this renderer is in `LOST` state.
public abstract int	getCompatibleHeight(int h)
public PoolFilterable	getCompatibleImage(int w, int h)
public abstract int	getCompatibleWidth(int w)
public final synchronized EffectPeer<T extends RenderState>	Returns: cached peer for this name and unroll count getPeerInstance(FilterContext filter context - same as this renderer's context fctx, String not-unrolled name of the peer name, int unrollCount) Returns a (cached) instance of peer given the context, name and unroll count.
protected Collection<EffectPeer<T extends RenderState>>	getPeers() Returns current cache of peers.
public static synchronized Renderer	Returns: renderer getRenderer(FilterContext context to create the renderer for fctx) Returns a renderer associated with given filter context based on the environment and flags set.
public static Renderer	Returns: renderer getRenderer(FilterContext context to create the renderer for fctx, Effect uses in the rendering effect, int approximate input width approxW, int approximate input height approxH) Returns a renderer that is most optimal for the approximate size of the filtering operation.
protected Renderer	Returns: the `Renderer` best suited for this size getRendererForSize(Effect effect, int approximate input width approxW, int approximate input height approxH) Returns a `Renderer` instance that is most appropriate for the given size of the source data.
public abstract Renderer.RendererState	Returns: the state getRendererState() Returns this renderer's current state.
protected static Renderer	Returns: an instance of Renderer that uses CPU filtering getSoftwareRenderer() This method can be used by subclasses to create a backup renderer, either a SW (Java) renderer or an SSE (native) renderer, depending on what is available.
public abstract boolean	Returns: true if this image data is compatible, false otherwise isImageDataCompatible(ImageData `ImageData` to be checked id) Determines whether the passed `ImageData` is compatible with this renderer (that is, if it can be used as a input source for this renderer's peers).
public void	releaseCompatibleImage(Filterable image)
public void	releasePurgatory() This is a temporary workaround for a PowerVR SGX issue.
public ImageData	transform(FilterContext fctx, ImageData img, int xpow2scales, int ypow2scales)
public abstract Filterable	transform(FilterContext fctx, Filterable original, BaseTransform transform, Rectangle origBounds, Rectangle xformBounds)
public abstract ImageData	transform(FilterContext fctx, ImageData original, BaseTransform transform, Rectangle origBounds, Rectangle xformBounds)
public void	updateFloatTexture(LockableResource texture, FloatMap map)

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

Field Detail

imagePool	back to summary
private final ImagePool imagePool

peerCache	back to summary
private Map<String, EffectPeer<T extends RenderState>> peerCache

rendererMap	back to summary
private static final Map<FilterContext, Renderer> rendererMap

rootPkg	back to summary
public static final String rootPkg

verbose	back to summary
protected static final boolean verbose

Constructor Detail

Renderer	back to summary
protected Renderer()

Method Detail

clearImage back to summary

clearImage	back to summary
public abstract void clearImage(Filterable image) Mainly used by `ImagePool` for the purpose of clearing an image before handing it back to the user. Parameters image:Filterable the image to be cleared

public abstract void clearImage(Filterable image)

Mainly used by ImagePool for the purpose of clearing an image before handing it back to the user.

Parameters

image:Filterable: the image to be cleared

createCompatibleImage	back to summary
public abstract PoolFilterable createCompatibleImage(int w, int h)

createFloatTexture	back to summary
public LockableResource createFloatTexture(int w, int h)

createImageData back to summary

createImageData	back to summary
public abstract ImageData createImageData(FilterContext fctx, Filterable src) Mainly used by the `Identity` effect for the purpose of creating a cached `ImageData` from the given platform-specific image (e.g. a `BufferedImage` wrapped in a `J2DImage`). Parameters fctx:FilterContext the filter context Returns:ImageData a new `ImageData`

public abstract ImageData createImageData(FilterContext fctx, Filterable src)

Mainly used by the Identity effect for the purpose of creating a cached ImageData from the given platform-specific image (e.g. a BufferedImage wrapped in a J2DImage).

Parameters

fctx:FilterContext: the filter context

Returns:ImageData

a new ImageData

createPeer	back to summary
protected abstract EffectPeer<T extends RenderState> createPeer(FilterContext fctx, String name, int unrollCount) Creates a new peer given the context, name and unroll count. Parameters fctx:FilterContext context shared with the renderer name:String of the peer unrollCount:int unroll count Returns:EffectPeer<T extends RenderState> new peer

createPeer

back to summary

protected abstract EffectPeer<T extends RenderState> createPeer(FilterContext fctx, String name, int unrollCount)

Creates a new peer given the context, name and unroll count.

Parameters

fctx:FilterContext: context shared with the renderer
name:String: of the peer
unrollCount:int: unroll count

Returns:EffectPeer<T extends RenderState>

new peer

getAccelType back to summary

getAccelType	back to summary
public abstract Effect.AccelType getAccelType() Returns the `AccelType` used by default for peers of this renderer. Note that the Renderer may specialize in peers of this type, and it may create them in general by default, but the renderers all look for an Intrinsic peer for a given operation as well so the actual peer implementaiton for a given effect may sometimes differ from this `AccelType`. Care should be taken if the actual `AccelType` for a specific operation is needed, then the `EffectPeer#getAccelType()` should be consulted directly in those cases. Returns:Effect.AccelType the `AccelType` used by typical peers of this renderer

public abstract Effect.AccelType getAccelType()

Returns the AccelType used by default for peers of this renderer. Note that the Renderer may specialize in peers of this type, and it may create them in general by default, but the renderers all look for an Intrinsic peer for a given operation as well so the actual peer implementaiton for a given effect may sometimes differ from this AccelType. Care should be taken if the actual AccelType for a specific operation is needed, then the EffectPeer#getAccelType() should be consulted directly in those cases.

Returns:Effect.AccelType: the AccelType used by typical peers of this renderer

getBackupRenderer back to summary

getBackupRenderer	back to summary
protected abstract Renderer getBackupRenderer() Returns an instance of backup renderer to be used if this renderer is in `LOST` state. Returns:Renderer backup renderer

protected abstract Renderer getBackupRenderer()

Returns an instance of backup renderer to be used if this renderer is in LOST state.

Returns:Renderer: backup renderer

getCompatibleHeight	back to summary
public abstract int getCompatibleHeight(int h)

getCompatibleImage	back to summary
public PoolFilterable getCompatibleImage(int w, int h)

getCompatibleWidth	back to summary
public abstract int getCompatibleWidth(int w)

getPeerInstance	back to summary
public final synchronized EffectPeer<T extends RenderState> getPeerInstance(FilterContext fctx, String name, int unrollCount) Returns a (cached) instance of peer given the context, name and unroll count. Parameters fctx:FilterContext filter context - same as this renderer's context name:String not-unrolled name of the peer Returns:EffectPeer<T extends RenderState> cached peer for this name and unroll count

getPeerInstance

back to summary

public final synchronized EffectPeer<T extends RenderState> getPeerInstance(FilterContext fctx, String name, int unrollCount)

Returns a (cached) instance of peer given the context, name and unroll count.

Parameters

fctx:FilterContext: filter context - same as this renderer's context
name:String: not-unrolled name of the peer

Returns:EffectPeer<T extends RenderState>

cached peer for this name and unroll count

getPeers	back to summary
protected Collection<EffectPeer<T extends RenderState>> getPeers() Returns current cache of peers.

getRenderer	back to summary
public static synchronized Renderer getRenderer(FilterContext fctx) Returns a renderer associated with given filter context based on the environment and flags set. Renderers are per filter context cached. Parameters fctx:FilterContext context to create the renderer for Returns:Renderer renderer

getRenderer

back to summary

public static synchronized Renderer getRenderer(FilterContext fctx)

Returns a renderer associated with given filter context based on the environment and flags set. Renderers are per filter context cached.

Parameters

fctx:FilterContext: context to create the renderer for

Returns:Renderer

renderer

getRenderer	back to summary
public static Renderer getRenderer(FilterContext fctx, Effect effect, int approxW, int approxH) Returns a renderer that is most optimal for the approximate size of the filtering operation. Parameters fctx:FilterContext context to create the renderer for effect:Effect uses in the rendering approxW:int approximate input width approxH:int approximate input height Returns:Renderer renderer

getRenderer

back to summary

public static Renderer getRenderer(FilterContext fctx, Effect effect, int approxW, int approxH)

Returns a renderer that is most optimal for the approximate size of the filtering operation.

Parameters

fctx:FilterContext: context to create the renderer for
effect:Effect: uses in the rendering
approxW:int: approximate input width
approxH:int: approximate input height

Returns:Renderer

renderer

getRendererForSize back to summary

getRendererForSize	back to summary
protected Renderer getRendererForSize(Effect effect, int approxW, int approxH) Returns a `Renderer` instance that is most appropriate for the given size of the source data. The default implementation simply returns "this" renderer, but subclasses may override this method and return a different renderer depending on the size of the operation. For example, a GPU-based renderer may wish to return a software renderer for small-sized operations (because of lower overhead, etc). Parameters approxW:int approximate input width approxH:int approximate input height Returns:Renderer the `Renderer` best suited for this size

protected Renderer getRendererForSize(Effect effect, int approxW, int approxH)

Returns a Renderer instance that is most appropriate for the given size of the source data. The default implementation simply returns "this" renderer, but subclasses may override this method and return a different renderer depending on the size of the operation. For example, a GPU-based renderer may wish to return a software renderer for small-sized operations (because of lower overhead, etc).

Parameters

approxW:int: approximate input width
approxH:int: approximate input height

Returns:Renderer

the Renderer best suited for this size

getRendererState back to summary

getRendererState	back to summary
public abstract Renderer.RendererState getRendererState() Returns this renderer's current state. Returns:Renderer.RendererState the state See Also `RendererState`

public abstract Renderer.RendererState getRendererState()

Returns this renderer's current state.

Returns:Renderer.RendererState: the state
See Also: RendererState

getSoftwareRenderer	back to summary
protected static Renderer getSoftwareRenderer() This method can be used by subclasses to create a backup renderer, either a SW (Java) renderer or an SSE (native) renderer, depending on what is available. Returns:Renderer an instance of Renderer that uses CPU filtering

getSoftwareRenderer

back to summary

protected static Renderer getSoftwareRenderer()

This method can be used by subclasses to create a backup renderer, either a SW (Java) renderer or an SSE (native) renderer, depending on what is available.

Returns:Renderer: an instance of Renderer that uses CPU filtering

isImageDataCompatible back to summary

isImageDataCompatible	back to summary
public abstract boolean isImageDataCompatible(ImageData id) Determines whether the passed `ImageData` is compatible with this renderer (that is, if it can be used as a input source for this renderer's peers). Parameters id:ImageData `ImageData` to be checked Returns:boolean true if this image data is compatible, false otherwise

public abstract boolean isImageDataCompatible(ImageData id)

Determines whether the passed ImageData is compatible with this renderer (that is, if it can be used as a input source for this renderer's peers).

Parameters

id:ImageData: ImageData to be checked

Returns:boolean

true if this image data is compatible, false otherwise

releaseCompatibleImage	back to summary
public void releaseCompatibleImage(Filterable image)

releasePurgatory	back to summary
public void releasePurgatory() This is a temporary workaround for a PowerVR SGX issue. See ImagePool for more details.

transform	back to summary
public ImageData transform(FilterContext fctx, ImageData img, int xpow2scales, int ypow2scales)

transform	back to summary
public abstract Filterable transform(FilterContext fctx, Filterable original, BaseTransform transform, Rectangle origBounds, Rectangle xformBounds)

transform	back to summary
public abstract ImageData transform(FilterContext fctx, ImageData original, BaseTransform transform, Rectangle origBounds, Rectangle xformBounds)

updateFloatTexture	back to summary
public void updateFloatTexture(LockableResource texture, FloatMap map)

com.sun.scenario.effect.impl back to summary

public final Enum Renderer.RendererState

Class Inheritance

extends Enum<Renderer.RendererState>

java.lang.Object
java.lang.Enum
com.sun.scenario.effect.impl.Renderer.RendererState

Enumeration describing the lifecycle states of the renderer. When the renderer is created, it will either start in the OK state, or it will start in the NOTREADY state until the first time it is used during rendering, then transition to the OK state. It could become LOST at some point. This may happen for example if the renderer is susceptible to display changes.

When the renderer is in the LOST state it can't be used for rendering, instead a backup renderer must be used.

Sometime later the renderer could enter the DISPOSED state, at which point it will be removed from the cache and a new renderer will be created for the particular context.

Thus the lifecycle of a renderer is: [NOTREADY =>] OK [=> LOST [=> DISPOSED]]

Field Summary

Modifier and Type	Field and Description
public static final Renderer.RendererState	DISPOSED Renderer is disposed, it is no longer usable and must be replaced.
public static final Renderer.RendererState	LOST Renderer is lost, a backup renderer must be used.
public static final Renderer.RendererState	NOTREADY Renderer is not ready; it might be able to be used for rendering.
public static final Renderer.RendererState	OK Renderer can be used for rendering.

Constructor Summary

Access	Constructor and Description
private	RendererState()

Method Summary

Modifier and Type	Method and Description
public static Renderer.RendererState	valueOf(String name)
public static Renderer.RendererState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DISPOSED	back to summary
public static final Renderer.RendererState DISPOSED Renderer is disposed, it is no longer usable and must be replaced.

LOST	back to summary
public static final Renderer.RendererState LOST Renderer is lost, a backup renderer must be used.

NOTREADY	back to summary
public static final Renderer.RendererState NOTREADY Renderer is not ready; it might be able to be used for rendering.

OK	back to summary
public static final Renderer.RendererState OK Renderer can be used for rendering.

Constructor Detail

RendererState	back to summary
private RendererState()

Method Detail

valueOf	back to summary
public static Renderer.RendererState valueOf(String name)

values	back to summary
public static Renderer.RendererState[] values()

public abstract Class Renderer

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum Renderer.RendererState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail