API Reference / @gtkx/cairo / Surface

Abstract Class: Surface

Defined in: surface.d.ts:11

A cairo surface (cairo_surface_t): the target a context draws onto. Surfaces come from the create* statics, from ImageSurface and RecordingSurface, or from GTK, and wrap as the concrete class their backend reports (instanceof ImageSurface for an image surface).

Extended by

• ImageSurface
• RecordingSurface

Constructors

Constructor

new Surface(): Surface

Returns

Surface

Properties

__type__

__type__: bigint

Defined in: surface.d.ts:19

GType of CairoSurface, the boxed type this class is registered under.

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

---

finish()

finish(): void

Defined in: surface.d.ts:25

Finishes the surface and drops its backend resources; further drawing reports an error.

Returns

void

---

flush()

flush(): void

Defined in: surface.d.ts:27

Performs any pending drawing so the backend storage is up to date.

Returns

void

---

getContent()

getContent(): Content

Defined in: surface.d.ts:33

Returns whether the surface holds color, alpha or both.

Returns

Content

---

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

---

getDeviceOffset()

getDeviceOffset(): DeviceOffset

Defined in: surface.d.ts:41

Returns the offset added to device coordinates when drawing onto the surface.

Returns

DeviceOffset

---

getDeviceScale()

getDeviceScale(): DeviceScale

Defined in: surface.d.ts:43

Returns the scale applied between user and device units.

Returns

DeviceScale

---

getFallbackResolution()

getFallbackResolution(): FallbackResolution

Defined in: surface.d.ts:49

Returns the resolution used when vector content has to be rasterized.

Returns

FallbackResolution

---

getFontOptions()

getFontOptions(): FontOptions

Defined in: surface.d.ts:31

Returns the font options the surface's backend prefers for rendering text.

Returns

FontOptions

---

getReferenceCount()

getReferenceCount(): number

Defined in: surface.d.ts:53

Returns the reference count of the surface.

Returns

number

---

getType()

getType(): SurfaceType

Defined in: surface.d.ts:51

Returns the backend type of the surface.

Returns

SurfaceType

---

hasShowTextGlyphs()

hasShowTextGlyphs(): boolean

Defined in: surface.d.ts:59

Returns whether the surface supports Context.showTextGlyphs natively.

Returns

boolean

---

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

RectangleInt

Returns

Surface

---

markDirty()

markDirty(): void

Defined in: surface.d.ts:35

Tells cairo the surface's storage was modified outside of cairo.

Returns

void

---

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

---

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

---

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

---

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

---

showPage()

showPage(): void

Defined in: surface.d.ts:57

Emits the current page and starts a blank one, on paged backends.

Returns

void

---

status()

status(): Status

Defined in: surface.d.ts:23

Returns the error status of the surface, Status.SUCCESS when it is usable.

Returns

Status

---

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

---

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

Surface

Returns

void

---

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

Status

---

createForRectangle()

static createForRectangle(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

Surface

x

number

y

number

width

number

height

number

Returns

Surface

---

createSimilar()

static createSimilar(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

Surface

content

Content

width

number

height

number

Returns

Surface

---

createSimilarImage()

static createSimilarImage(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

Surface

format

Format

width

number

height

number

Returns

ImageSurface