Gegl.TileBackend¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`unlink_swap` (path)
	`command` (command, x, y, z, data)
	`get_flush_on_destroy` ()
	`get_tile_height` ()
	`get_tile_size` ()
	`get_tile_width` ()
	`peek_storage` ()
	`set_extent` (rectangle)
	`set_flush_on_destroy` (flush_on_destroy)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`flush-on-destroy`	`bool`	r/w	Cache tiles will be flushed before the backend is destroyed
`format`	`int`	r/w/co	babl format
`px-size`	`int`	r	Size of a single pixel in bytes
`tile-height`	`int`	r/w/co	Tile height in pixels
`tile-size`	`int`	r	Size of the tiles linear buffer in bytes
`tile-width`	`int`	r/w/co	Tile width in pixels

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Gegl.TileSource`	r

Class Details¶

class Gegl.TileBackend(**kwargs)¶

Bases:: Gegl.TileSource
Abstract:: No
Structure:: Gegl.TileBackendClass

classmethod unlink_swap(path)¶

Parameters:: path (str) – the path where the gegl tile backend has swapped.

Delete a swap file from disk. This must be used by tile backends which may swap to disk under certain circonstances.

For safety, this function will check that the swap file is in the swap directory before deletion but it won’t perform any other check.

Deprecated since version 0.4.14: This function is not compatible with a dynamically- changing swap path. Use Gegl.Buffer.swap_remove_file() instead.

command(command, x, y, z, data)¶

Parameters:

command (Gegl.TileCommand) – the tile command
x (int) – x coordinate
y (int) – y coordinate
z (int) – tile zoom level
data (object or None) – user data

Returns:

Command result.

Return type:

object or None

The default tile-backend command handler. Tile backends should forward commands they don’t handle themselves to this function.

get_flush_on_destroy()¶

Return type:: bool

get_tile_height()¶

Returns:: the height of tile from this backend
Return type:: int

get_tile_size()¶

Returns:: the size in bytes for a tile from this backend
Return type:: int

get_tile_width()¶

Returns:: the width of tile from this backend
Return type:: int

peek_storage()¶

Returns:: the #GeglTileStorage
Return type:: Gegl.TileSource

Gets a pointer to the GeglTileStorage that uses the backend

set_extent(rectangle)¶

Parameters:: rectangle (Gegl.Rectangle) – the new extent

Specify the extent of the backend, can be used to pre-prime the backend with the width/height information when constructing proxy GeglBuffers to interact with other systems

set_flush_on_destroy(flush_on_destroy)¶

Parameters:: flush_on_destroy (bool) – true if the backend needs to be flushed

Control whether cached data will be written to the backend before it is destroyed. If false unwritten data will be discarded.

Property Details¶

Gegl.TileBackend.props.flush_on_destroy¶

Name:: flush-on-destroy
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

Cache tiles will be flushed before the backend is destroyed

Gegl.TileBackend.props.format¶

Name:: format
Type:: int
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

babl format

Gegl.TileBackend.props.px_size¶

Name:: px-size
Type:: int
Default Value:: 0
Flags:: READABLE

Size of a single pixel in bytes

Gegl.TileBackend.props.tile_height¶

Name:: tile-height
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Tile height in pixels

Gegl.TileBackend.props.tile_size¶

Name:: tile-size
Type:: int
Default Value:: 0
Flags:: READABLE

Size of the tiles linear buffer in bytes

Gegl.TileBackend.props.tile_width¶

Name:: tile-width
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Tile width in pixels