Module org.freedesktop.cairo

Package org.freedesktop.cairo

Class RecordingSurface

java.lang.Object

io.github.jwharm.cairobindings.Proxy

org.freedesktop.cairo.Surface

org.freedesktop.cairo.RecordingSurface

All Implemented Interfaces:

AutoCloseable

public final class RecordingSurface
extends Surface

A recording surface records all drawing operations.

A recording surface is a surface that records all drawing operations at the highest level of the surface backend interface, (that is, the level of paint, mask, stroke, fill, and showTextGlyphs). The recording surface can then be "replayed" against any target surface by using it as a source surface.

If you want to replay a surface so that the results in target will be identical to the results that would have been obtained if the original operations applied to the recording surface had instead been applied to the target surface, you can use code like this:

 Context cr = Context.create(target);
 cr.setSourceSurface(recordingSurface, 0.0, 0.0);
 cr.paint();
 

A recording surface is logically unbounded, i.e. it has no implicit constraint on the size of the drawing surface. However, in practice this is rarely useful as you wish to replay against a particular target surface with known bounds. For this case, it is more efficient to specify the target extents to the recording surface upon creation.

The recording phase of the recording surface is careful to snapshot all necessary objects (paths, patterns, etc.), in order to achieve accurate replay.

See Also:

• Surface

Constructor Summary

Constructors

Constructor	Description
RecordingSurface(MemorySegment address)	Constructor used internally to instantiate a java RecordingSurface object for a native cairo_surface_t instance

Method Summary

Modifier and Type	Method	Description
static RecordingSurface	create(Content content, Rectangle extents)	Creates a recording-surface which can be used to record all drawing operations at the highest level (that is, the level of paint, mask, stroke, fill, and showTextGlyphs).
void	getExtents(Rectangle extents)	Get the extents of the recording-surface.
Rect	inkExtents()	Measures the extents of the operations stored within the recording-surface.

Methods inherited from class org.freedesktop.cairo.Surface

close, copyPage, createForRectangle, createSimilar, createSimilarImage, destroy, finish, flush, getContent, getDevice, getDeviceOffset, getDeviceScale, getFallbackResolution, getFontOptions, getMimeData, getSurfaceType, getType, getUserData, hasShowTextGlyphs, mapToImage, markDirty, markDirtyRectangle, setDeviceOffset, setDeviceScale, setFallbackResolution, setMimeData, setUserData, showPage, status, supportsMimeType, unmapImage

Methods inherited from class io.github.jwharm.cairobindings.Proxy

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

RecordingSurface

public RecordingSurface(MemorySegment address)

Constructor used internally to instantiate a java RecordingSurface object for a native cairo_surface_t instance

Parameters:

address - the memory address of the native cairo_surface_t instance

Method Details

create

public static RecordingSurface create(Content content,
 Rectangle extents)

Creates a recording-surface which can be used to record all drawing operations at the highest level (that is, the level of paint, mask, stroke, fill, and showTextGlyphs). The recording surface can then be "replayed" against any target surface by using it as a source to drawing operations.

The recording phase of the recording surface is careful to snapshot all necessary objects (paths, patterns, etc.), in order to achieve accurate replay.

Parameters:

content - the content of the recording surface

extents - the extents to record in pixels, can be null to record unbounded operations.

Returns:

the newly created surface

Since:

1.10

inkExtents

public Rect inkExtents()

Measures the extents of the operations stored within the recording-surface. This is useful to compute the required size of an image surface (or equivalent) into which to replay the full sequence of drawing operations.

Returns:

a rectangle with the x- and y-coordinates of the top-left, the width and the height of the ink bounding box

Since:

1.10

getExtents

public void getExtents(Rectangle extents)
                throws IllegalStateException

Get the extents of the recording-surface.

Parameters:

extents - the Rectangle to be assigned the extents

Throws:

IllegalStateException - if the surface is not bounded, or in an error state

Since:

1.12