Module org.freedesktop.cairo

Package org.freedesktop.cairo

Class SurfaceObserver

java.lang.Object

io.github.jwharm.cairobindings.Proxy

org.freedesktop.cairo.Surface

org.freedesktop.cairo.SurfaceObserver

All Implemented Interfaces:

AutoCloseable

public final class SurfaceObserver
extends Surface

A surface that exists solely to watch what another surface is doing.

See Also:

• Surface

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SurfaceObserver	addFillCallback(SurfaceObserverCallback func)	Adds a callback for fill operations on the observed surface.
SurfaceObserver	addFinishCallback(SurfaceObserverCallback func)	Adds a callback for finish operations on the observed surface.
SurfaceObserver	addFlushCallback(SurfaceObserverCallback func)	Adds a callback for flush operations on the observed surface.
SurfaceObserver	addGlyphsCallback(SurfaceObserverCallback func)	Adds a callback for glyph operations on the observed surface.
SurfaceObserver	addMaskCallback(SurfaceObserverCallback func)	Adds a callback for mask operations on the observed surface.
SurfaceObserver	addPaintCallback(SurfaceObserverCallback func)	Adds a callback for paint operations on the observed surface.
SurfaceObserver	addStrokeCallback(SurfaceObserverCallback func)	Adds a callback for stroke operations on the observed surface.
static SurfaceObserver	create(Surface target, SurfaceObserverMode mode)	Create a new surface that exists solely to watch another is doing.
double	elapsed()	Returns the total observation time.
void	print(WriteFunc writeFunc)	Prints the observer log using the given callback.

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

SurfaceObserver

public SurfaceObserver(MemorySegment address)

Constructor used internally to instantiate a java SurfaceObserver 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 SurfaceObserver create(Surface target,
 SurfaceObserverMode mode)

Create a new surface that exists solely to watch another is doing. In the process it will log operations and times, which are fast, which are slow, which are frequent, etc.

The mode parameter can be set to either SurfaceObserverMode.NORMAL or SurfaceObserverMode.RECORD_OPERATIONS, to control whether or not the internal observer should record operations.

Parameters:

target - an existing surface for which the observer will watch

mode - sets the mode of operation (normal vs. record)

Returns:

the newly allocated surface

Since:

1.12

addFillCallback

public SurfaceObserver addFillCallback(SurfaceObserverCallback func)

Adds a callback for fill operations on the observed surface.

Parameters:

func - callback function for fill operations

Returns:

this SurfaceObserver

Since:

1.12

addFinishCallback

public SurfaceObserver addFinishCallback(SurfaceObserverCallback func)

Adds a callback for finish operations on the observed surface.

Parameters:

func - callback function for the finish operation

Returns:

this SurfaceObserver

Since:

1.12

addFlushCallback

public SurfaceObserver addFlushCallback(SurfaceObserverCallback func)

Adds a callback for flush operations on the observed surface.

Parameters:

func - callback for flush operations

Returns:

this SurfaceObserver

Since:

1.12

addGlyphsCallback

public SurfaceObserver addGlyphsCallback(SurfaceObserverCallback func)

Adds a callback for glyph operations on the observed surface.

Parameters:

func - callback function for glyph operations

Returns:

this SurfaceObserver

Since:

1.12

addMaskCallback

public SurfaceObserver addMaskCallback(SurfaceObserverCallback func)

Adds a callback for mask operations on the observed surface.

Parameters:

func - callback function for mask operations

Returns:

this SurfaceObserver

Since:

1.12

addPaintCallback

public SurfaceObserver addPaintCallback(SurfaceObserverCallback func)

Adds a callback for paint operations on the observed surface.

Parameters:

func - callback function for paint operations

Returns:

this SurfaceObserver

Since:

1.12

addStrokeCallback

public SurfaceObserver addStrokeCallback(SurfaceObserverCallback func)

Adds a callback for stroke operations on the observed surface.

Parameters:

func - callback function for stroke operations

Returns:

this SurfaceObserver

Since:

1.12

elapsed

public double elapsed()

Returns the total observation time.

Returns:

the elapsed time, in nanoseconds

Since:

1.12

print

public void print(WriteFunc writeFunc)

Prints the observer log using the given callback.

Parameters:

writeFunc - callback for writing on a stream

Since:

1.12