Module org.freedesktop.cairo

Package org.freedesktop.cairo

Class Script

java.lang.Object

io.github.jwharm.cairobindings.Proxy

org.freedesktop.cairo.Device

org.freedesktop.cairo.Script

All Implemented Interfaces:

AutoCloseable

public class Script
extends Device

Output device for use with a ScriptSurface.

The script surface provides the ability to render to a native script that matches the cairo drawing model. The scripts can be replayed using tools under the util/cairo-script directory, or with cairo-perf-trace.

Since:

1.12

See Also:

• Surface
• ScriptSurface
• Device

Constructor Summary

Constructors

Constructor	Description
Script(MemorySegment address)	Constructor used internally to instantiate a java ScriptSurface object for a native cairo_device_t instance

Method Summary

Modifier and Type	Method	Description
static Script	create(OutputStream stream)	Creates a output device for emitting the script, used when creating the individual surfaces.
static Script	create(String filename)	Creates a output device for emitting the script, used when creating the individual surfaces.
ScriptSurface	createScriptSurface(Content content, double width, double height)	Create a new surface that will emit its rendering through this script (output device)
ScriptSurface	createScriptSurfaceForTarget(Surface target)	Create a proxy surface that will render to target and record the operations to this script (output device).
void	from(RecordingSurface recordingSurface)	Converts the record operations in recordingSurface into a script.
ScriptMode	getMode()	Queries the script for its current output mode.
void	setMode(ScriptMode mode)	Change the output mode of the script
void	writeComment(String comment)	Emit a string verbatim into the script.

Methods inherited from class org.freedesktop.cairo.Device

acquire, close, destroy, finish, flush, getDeviceType, getType, getUserData, observerElapsed, observerFillElapsed, observerGlyphsElapsed, observerMaskElapsed, observerPaintElapsed, observerPrint, observerStrokeElapsed, release, setUserData, status

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

Script

public Script(MemorySegment address)

Constructor used internally to instantiate a java ScriptSurface object for a native cairo_device_t instance

Parameters:

address - the memory address of the native cairo_device_t instance

Method Details

create

public static Script create(String filename)

Creates a output device for emitting the script, used when creating the individual surfaces.

Parameters:

filename - the name (path) of the file to write the script to

Returns:

the newly created device

Since:

1.12

create

public static Script create(OutputStream stream)

Creates a output device for emitting the script, used when creating the individual surfaces.

Parameters:

stream - OutputStream passed the bytes written to the script

Returns:

the newly created device

Since:

1.12

from

public void from(RecordingSurface recordingSurface)

Converts the record operations in recordingSurface into a script.

Parameters:

recordingSurface - the recording surface to replay

Since:

1.12

getMode

public ScriptMode getMode()

Queries the script for its current output mode.

Returns:

the current output mode of the script

Since:

1.12

setMode

public void setMode(ScriptMode mode)

Change the output mode of the script

Parameters:

mode - the new mode

Since:

1.12

createScriptSurface

public ScriptSurface createScriptSurface(Content content,
 double width,
 double height)

Create a new surface that will emit its rendering through this script (output device)

Parameters:

content - the content of the surface

width - width in pixels

height - height in pixels

Returns:

the newly created surface

Since:

1.12

createScriptSurfaceForTarget

public ScriptSurface createScriptSurfaceForTarget(Surface target)

Create a proxy surface that will render to target and record the operations to this script (output device).

Parameters:

target - a target surface to wrap

Returns:

the newly created surface.

Since:

1.12

writeComment

public void writeComment(String comment)

Emit a string verbatim into the script.

Parameters:

comment - the string to emit

Since:

1.12