Package com.myscript.iink

Interface IRenderTarget

public interface IRenderTarget

Represents a render target for the iink renderer.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IRenderTarget.LayerType	Represents the type of a layer

Method Summary

Modifier and Type	Method	Description
@Nullable ICanvas	createOffscreenRenderCanvas(int surfaceId)	Creates a Canvas that draws onto the offscreen render surface associated with a given identifier.
int	createOffscreenRenderSurface(int width, int height, boolean alphaMask)	Requests the creation of an offscreen render surface (e.g.
float	getPixelDensity()	Returns the render target pixel density.
void	invalidate(@NotNull Renderer renderer, int x, int y, int width, int height, @NotNull java.util.EnumSet<IRenderTarget.LayerType> layers)	Invalidates a specified rectangle area on the given set of layers.
void	invalidate(@NotNull Renderer renderer, @NotNull java.util.EnumSet<IRenderTarget.LayerType> layers)	Invalidates the given set of layers.
void	releaseOffscreenRenderSurface(int surfaceId)	Requests the release of the offscreen render surface associated with a given identifier.
boolean	supportsOffscreenRendering()	Indicates whether this render target supports offscreen rendering.

Method Detail

invalidate

void invalidate(@NotNull
                @NotNull Renderer renderer,
                @NotNull
                @NotNull java.util.EnumSet<IRenderTarget.LayerType> layers)

Invalidates the given set of layers.

Parameters:

renderer - the renderer to which this render target has been bound.

layers - the set of layers to invalidate.

invalidate

void invalidate(@NotNull
                @NotNull Renderer renderer,
                int x,
                int y,
                int width,
                int height,
                @NotNull
                @NotNull java.util.EnumSet<IRenderTarget.LayerType> layers)

Invalidates a specified rectangle area on the given set of layers. The rectangle area is specified in pixel coordinates.

Parameters:

renderer - the renderer to which this render target has been bound.

x - the x position of the rectangle area (view coordinates in pixel).

y - the y position of the rectangle area (view coordinates in pixel).

width - the width of the rectangle area (view coordinates in pixel).

height - the height of the rectangle area (view coordinates in pixel).

layers - the set of layers to invalidate.

supportsOffscreenRendering

boolean supportsOffscreenRendering()

Indicates whether this render target supports offscreen rendering.

Returns:

true if offscreen rendering is supported, otherwise false.

Since:

2.0

getPixelDensity

float getPixelDensity()

Returns the render target pixel density.

Returns:

the render target pixel density.

Since:

2.0

createOffscreenRenderSurface

int createOffscreenRenderSurface(int width,
                                 int height,
                                 boolean alphaMask)

Requests the creation of an offscreen render surface (e.g. a bitmap), and returns a unique identifier for that surface.

Parameters:

width - the width of the surface to create (view coordinates in pixel).

height - the height of the surface to create (view coordinates in pixel).

alphaMask - request creation of an alpha mask. Only the alpha channel is relevant. The actual red, green and blue channel values are given by the blend color.

Returns:

a unique identifier associated with the created surface.

Note: createOffscreenRenderCanvas() will be called with this identifier, to request drawing of the associated surface.

Since:

2.0

releaseOffscreenRenderSurface

void releaseOffscreenRenderSurface(int surfaceId)

Requests the release of the offscreen render surface associated with a given identifier.

Parameters:

surfaceId - the identifier of the surface to release.

Since:

2.0

createOffscreenRenderCanvas

@Nullable
@Nullable ICanvas createOffscreenRenderCanvas(int surfaceId)

Creates a Canvas that draws onto the offscreen render surface associated with a given identifier.

Parameters:

surfaceId - the identifier of the surface to be drawn.

Returns:

a Canvas to draw on the requested surface.

Since:

2.0