API Reference / @gtkx/cairo / RecordingSurface
Class: RecordingSurface
Defined in: surface.d.ts:87
A surface that records the drawing operations applied to it, for replaying them onto other surfaces.
Extends
Constructors
Constructor
new RecordingSurface(
content,extents?):RecordingSurface
Defined in: surface.d.ts:91
Creates a recording surface of the given content, bounded to extents or unbounded when omitted.
Parameters
content
extents?
Returns
RecordingSurface
Overrides
Properties
__type__
__type__:
bigint
Defined in: surface.d.ts:19
GType of CairoSurface, the boxed type this class is registered under.
Inherited from
Methods
copyPage()
copyPage():
void
Defined in: surface.d.ts:55
Emits the current page and keeps its content for the next one, on paged backends.
Returns
void
Inherited from
finish()
finish():
void
Defined in: surface.d.ts:25
Finishes the surface and drops its backend resources; further drawing reports an error.
Returns
void
Inherited from
flush()
flush():
void
Defined in: surface.d.ts:27
Performs any pending drawing so the backend storage is up to date.
Returns
void
Inherited from
getContent()
getContent():
Content
Defined in: surface.d.ts:33
Returns whether the surface holds color, alpha or both.
Returns
Inherited from
getDevice()
getDevice():
ExternalObject<Handle> |null
Defined in: surface.d.ts:29
Returns the raw handle of the device behind the surface, or null when it has none.
Returns
ExternalObject<Handle> | null
Inherited from
getDeviceOffset()
getDeviceOffset():
DeviceOffset
Defined in: surface.d.ts:41
Returns the offset added to device coordinates when drawing onto the surface.
Returns
Inherited from
getDeviceScale()
getDeviceScale():
DeviceScale
Defined in: surface.d.ts:43
Returns the scale applied between user and device units.
Returns
Inherited from
getExtents()
getExtents():
RectangleData|null
Defined in: surface.d.ts:95
Returns the extents the surface was created with, or null for an unbounded surface.
Returns
RectangleData | null
getFallbackResolution()
getFallbackResolution():
FallbackResolution
Defined in: surface.d.ts:49
Returns the resolution used when vector content has to be rasterized.
Returns
Inherited from
getFontOptions()
getFontOptions():
FontOptions
Defined in: surface.d.ts:31
Returns the font options the surface's backend prefers for rendering text.
Returns
Inherited from
getReferenceCount()
getReferenceCount():
number
Defined in: surface.d.ts:53
Returns the reference count of the surface.
Returns
number
Inherited from
getType()
getType():
SurfaceType
Defined in: surface.d.ts:51
Returns the backend type of the surface.
Returns
Inherited from
hasShowTextGlyphs()
hasShowTextGlyphs():
boolean
Defined in: surface.d.ts:59
Returns whether the surface supports Context.showTextGlyphs natively.
Returns
boolean
Inherited from
inkExtents()
inkExtents():
InkExtents
Defined in: surface.d.ts:93
Returns the area that has been drawn on so far.
Returns
mapToImage()
mapToImage(
extents):Surface
Defined in: surface.d.ts:63
Returns an image surface giving direct access to the pixels of extents; release it with unmapImage.
Parameters
extents
Returns
Inherited from
markDirty()
markDirty():
void
Defined in: surface.d.ts:35
Tells cairo the surface's storage was modified outside of cairo.
Returns
void
Inherited from
markDirtyRectangle()
markDirtyRectangle(
x,y,width,height):void
Defined in: surface.d.ts:37
Tells cairo the given rectangle of the surface's storage was modified outside of cairo.
Parameters
x
number
y
number
width
number
height
number
Returns
void
Inherited from
setDeviceOffset()
setDeviceOffset(
xOffset,yOffset):void
Defined in: surface.d.ts:39
Sets the offset added to device coordinates when drawing onto the surface.
Parameters
xOffset
number
yOffset
number
Returns
void
Inherited from
setDeviceScale()
setDeviceScale(
xScale,yScale):void
Defined in: surface.d.ts:45
Sets the scale applied between user and device units.
Parameters
xScale
number
yScale
number
Returns
void
Inherited from
setFallbackResolution()
setFallbackResolution(
xPixelsPerInch,yPixelsPerInch):void
Defined in: surface.d.ts:47
Sets the resolution used when vector content has to be rasterized.
Parameters
xPixelsPerInch
number
yPixelsPerInch
number
Returns
void
Inherited from
showPage()
showPage():
void
Defined in: surface.d.ts:57
Emits the current page and starts a blank one, on paged backends.
Returns
void
Inherited from
status()
status():
Status
Defined in: surface.d.ts:23
Returns the error status of the surface, Status.SUCCESS when it is usable.
Returns
Inherited from
supportsMimeType()
supportsMimeType(
mimeType):boolean
Defined in: surface.d.ts:61
Returns whether the surface can embed data of the given MIME type.
Parameters
mimeType
string
Returns
boolean
Inherited from
unmapImage()
unmapImage(
image):void
Defined in: surface.d.ts:65
Uploads the pixels of image, obtained from mapToImage, back to the surface and releases it.
Parameters
image
Returns
void
Inherited from
writeToPng()
writeToPng(
filename):Status
Defined in: surface.d.ts:21
Writes the surface to a PNG file at filename and returns the resulting status.
Parameters
filename
string
Returns
Inherited from
create()
staticcreate(content,extents?):RecordingSurface
Defined in: surface.d.ts:89
Creates a recording surface, the same as new RecordingSurface(...).
Parameters
content
extents?
Returns
RecordingSurface
createForRectangle()
staticcreateForRectangle(target,x,y,width,height):Surface
Defined in: surface.d.ts:17
Creates a surface that draws onto the given rectangle of target.
Parameters
target
x
number
y
number
width
number
height
number
Returns
Inherited from
createSimilar()
staticcreateSimilar(other,content,width,height):Surface
Defined in: surface.d.ts:13
Creates a surface of the given content and size as compatible as possible with other.
Parameters
other
content
width
number
height
number
Returns
Inherited from
createSimilarImage()
staticcreateSimilarImage(other,format,width,height):ImageSurface
Defined in: surface.d.ts:15
Creates an image surface of the given format and size as compatible as possible with other.
Parameters
other
format
width
number
height
number