Struct gegl::Buffer

#[repr(transparent)]
pub struct Buffer { /* private fields */ }

Properties

abyss-height

Readable | Writeable | Construct Only

abyss-width

Readable | Writeable | Construct Only

abyss-x

Readable | Writeable | Construct Only

abyss-y

Readable | Writeable | Construct Only

backend

Readable | Writeable | Construct Only

format

Readable | Writeable | Construct

height

Readable | Writeable | Construct

initialized

Readable | Writeable | Construct Only

path

Readable | Writeable | Construct Only

pixels

Readable

px-size

Readable

shift-x

Readable | Writeable | Construct Only

shift-y

Readable | Writeable | Construct Only

tile-height

Readable | Writeable | Construct Only

tile-width

Readable | Writeable | Construct Only

width

Readable | Writeable | Construct

x

Readable | Writeable | Construct

y

Readable | Writeable | Construct

TileHandler

source

Readable | Writeable | Construct

Signals

changed

Implements

TileHandlerExt, [TileSourceExt][trait@crate::prelude::TileSourceExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Buffer

pub fn introspectable_new( format_name: &str, x: i32, y: i32, width: i32, height: i32 ) -> Buffer

Create a new GeglBuffer with the given format and dimensions.

format_name

The Babl format name for this buffer, e.g. “RGBA float”

x

x origin of the buffer’s extent

y

y origin of the buffer’s extent

width

width of the buffer’s extent

height

height of the buffer’s extent

pub fn for_backend( extent: &Rectangle, backend: &impl IsA<TileBackend> ) -> Buffer

Create a new GeglBuffer from a backend, if NULL is passed in the extent of the buffer will be inherited from the extent of the backend.

returns a GeglBuffer, that holds a reference to the provided backend.

extent

the geometry of the buffer (origin, width and height) a GeglRectangle.

backend

an instance of a GeglTileBackend subclass.

pub fn builder() -> BufferBuilder

Creates a new builder-pattern struct instance to construct Buffer objects.

This method returns an instance of BufferBuilder which can be used to create Buffer objects.

pub fn clear(&self, roi: &Rectangle)

Clears the provided rectangular region by setting all the associated memory to 0.

roi

a rectangular region

pub fn copy( &self, src_rect: &Rectangle, repeat_mode: AbyssPolicy, dst: &Buffer, dst_rect: &Rectangle )

pub fn create_sub_buffer(&self, extent: &Rectangle) -> Option<Buffer>

Create a new sub GeglBuffer, that is a view on a larger buffer.

extent

coordinates of new buffer.

Returns

the new sub buffer

pub fn dup(&self) -> Option<Buffer>

Duplicate a buffer (internally uses gegl_buffer_copy). Aligned tiles will create copy-on-write clones in the new buffer.

Returns

the new buffer

pub fn flush(&self)

Flushes all unsaved data to disk, this is not necessary for shared geglbuffers opened with gegl_buffer_open since they auto-sync on writes.

pub fn flush_ext(&self, rect: &Rectangle)

Invokes the external flush function, if any is set on the provided buffer - this ensures that data pending - in the current implementation only OpenCL - externally to be synchronized with the buffer. Multi threaded code should call such a synchronization before branching out to avoid each of the threads having an implicit synchronization of its own.

rect

rectangle

pub fn freeze_changed(&self)

Blocks emission of the “changed” signal for self.

While the signal is blocked, changes to self are accumulated, and will be emitted once the signal is unblocked, using thaw_changed().

pub fn abyss(&self) -> Option<Rectangle>

Return the abyss extent of a buffer, this expands out to the parents extent in subbuffers.

pub fn extent(&self) -> Option<Rectangle>

Returns a pointer to a GeglRectangle structure defining the geometry of a specific GeglBuffer, this is also the default width/height of buffers passed in to gegl_buffer_set and gegl_buffer_get (with a scale of 1.0 at least).

pub fn introspectable_get( &self, rect: &Rectangle, scale: f64, format_name: Option<&str>, repeat_mode: AbyssPolicy ) -> Vec<u8>

Fetch a rectangular linear buffer of pixel data from the GeglBuffer.

rect

the coordinates we want to retrieve data from.

scale

sampling scale, 1.0 = pixel for pixel 2.0 = magnify, 0.5 scale down.

format_name

the format to store data in, if NULL the format of the buffer is used.

repeat_mode

how requests outside the buffer extent are handled. Valid values: GEGL_ABYSS_NONE (abyss pixels are zeroed), GEGL_ABYSS_WHITE (abyss pixels are white), GEGL_ABYSS_BLACK (abyss pixels are black), GEGL_ABYSS_CLAMP (coordinates are clamped to the abyss rectangle), GEGL_ABYSS_LOOP (buffer contents are tiled if outside of the abyss rectangle).

Returns

A copy of the requested data

pub fn introspectable_set( &self, rect: &Rectangle, format_name: &str, src: &[u8] )

Store a linear raster buffer into the GeglBuffer.

rect

the rectangle to write.

format_name

the format of the input data.

src

pixel data to write to self.

pub fn sample_cleanup(&self)

👎Deprecated: Since 0.4.2

Clean up resources used by sampling framework of buffer.

Deprecated since 0.4.2

This function has no effect. It is not necessary to call it after using gegl_buffer_sample() or gegl_buffer_sample_at_level().

pub fn save(&self, path: &str, roi: &Rectangle)

Write a GeglBuffer to a file.

path

the path where the gegl buffer will be saved, any writable GIO uri is valid.

roi

the region of interest to write, this is the tiles that will be collected and written to disk.

pub fn set_abyss(&self, abyss: &Rectangle) -> bool

Changes the size and position of the abyss rectangle of a buffer.

Returns TRUE if the change of abyss was successful.

abyss

new abyss.

pub fn set_color(&self, rect: &Rectangle, color: &impl IsA<Color>)

Sets the region covered by rect to the specified color.

rect

a rectangular region to fill with a color.

color

the GeglColor to fill with.

pub fn set_extent(&self, extent: &Rectangle) -> bool

Changes the size and position that is considered active in a buffer, this operation is valid on any buffer, reads on subbuffers outside the master buffer’s extent are at the moment undefined.

Returns TRUE if the change of extent was successful.

extent

new extent.

pub fn set_pattern( &self, rect: &Rectangle, pattern: &Buffer, x_offset: i32, y_offset: i32 )

Fill a region with a repeating pattern. Offsets parameters are relative to the origin (0, 0) and not to the rectangle. So be carefull about the origin of pattern and self extents.

rect

the region of self to fill

pattern

a Buffer to be repeated as a pattern

x_offset

where the pattern starts horizontally

y_offset

where the pattern starts vertical

pub fn share_storage(&self, buffer2: &Buffer) -> bool

Checks if a pair of buffers share the same underlying tile storage.

Returns TRUE if self and buffer2 share the same storage.

buffer2

a Buffer.

pub fn thaw_changed(&self)

Unblocks emission of the “changed” signal for self.

Once all calls to freeze_changed() are matched by corresponding calls to freeze_changed(), all accumulated changes are emitted.

pub fn abyss_height(&self) -> i32

pub fn abyss_width(&self) -> i32

pub fn abyss_x(&self) -> i32

pub fn abyss_y(&self) -> i32

pub fn backend(&self) -> Option<TileBackend>

pub fn height(&self) -> i32

pub fn set_height(&self, height: i32)

pub fn is_initialized(&self) -> bool

pub fn path(&self) -> Option<GString>

pub fn pixels(&self) -> i32

pub fn px_size(&self) -> i32

pub fn shift_x(&self) -> i32

pub fn shift_y(&self) -> i32

pub fn tile_height(&self) -> i32

pub fn tile_width(&self) -> i32

pub fn width(&self) -> i32

pub fn set_width(&self, width: i32)

pub fn x(&self) -> i32

pub fn set_x(&self, x: i32)

pub fn y(&self) -> i32

pub fn set_y(&self, y: i32)

pub fn load(path: &str) -> Option<Buffer>

Loads an existing GeglBuffer from disk, if it has previously been saved with gegl_buffer_save it should be possible to open through any GIO transport, buffers that have been used as swap needs random access to be opened.

path

the path to a gegl buffer on disk.

Returns

a Buffer object.

pub fn open(path: &str) -> Option<Buffer>

Open an existing on-disk GeglBuffer, this buffer is opened in a monitored state so multiple instances of gegl can share the same buffer. Sets on one buffer are reflected in the other.

path

the path to a gegl buffer on disk.

Returns

a GeglBuffer object.

pub fn swap_create_file(suffix: Option<&str>) -> Option<PathBuf>

Generates a unique filename in the GEGL swap directory, suitable for using as swap space. When the file is no longer needed, it may be removed with swap_remove_file(); otherwise, it will be removed when exit() is called.

suffix

a string to suffix the filename with, for identification purposes, or None.

Returns

a string containing the full file path, or None is the swap is disabled. The returned string should be freed with g_free() when no longer needed.

pub fn swap_has_file(path: impl AsRef<Path>) -> bool

Tests if path is a swap file, that is, if it has been created with swap_create_file(), and hasn’t been removed yet.

path

a filename

pub fn swap_remove_file(path: impl AsRef<Path>)

Removes a swap file, generated using swap_create_file(), unlinking the file, if exists.

path

the swap file to remove, as returned by swap_create_file()

pub fn connect_changed<F: Fn(&Self, &Rectangle) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_format_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_height_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_pixels_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_px_size_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_width_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_x_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

pub fn connect_y_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Buffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Buffer

type ParamSpec = ParamSpecObject

type SetValue = Buffer

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Buffer>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Buffer

fn hash<H>(&self, state: &mut H)where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Buffer

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Buffer

type Parent = TileHandler

impl<OT: ObjectType> PartialEq<OT> for Buffer

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Buffer

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Buffer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Buffer

impl IsA<TileHandler> for Buffer

impl IsA<TileSource> for Buffer