Gimp.ColorTransform¶

Subclasses:: None

Methods¶

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

class	`can_gegl_copy` (src_profile, dest_profile)
class	`new` (src_profile, src_format, dest_profile, dest_format, rendering_intent, flags)
class	`new_proofing` (src_profile, src_format, dest_profile, dest_format, proof_profile, proof_intent, display_intent, flags)
	`process_buffer` (src_buffer, src_rect, dest_buffer, dest_rect)
	`process_pixels` (src_format, src_pixels, dest_format, dest_pixels, length)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`progress`

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Gimp.ColorTransform(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Gimp.ColorTransformClass

Definitions and Functions relating to LCMS.

classmethod can_gegl_copy(src_profile, dest_profile)¶

Parameters:

src_profile (Gimp.ColorProfile) – source Gimp.ColorProfile
dest_profile (Gimp.ColorProfile) – destination Gimp.ColorProfile

Returns:

True if pixels can be correctly converted between src_profile and dest_profile by simply using Gegl.Buffer.copy(), Babl.process() or similar.

Return type:

bool

This function checks if a Gimp.ColorTransform is needed at all.

New in version 2.10.

classmethod new(src_profile, src_format, dest_profile, dest_format, rendering_intent, flags)¶

Parameters:

src_profile (Gimp.ColorProfile) – the source Gimp.ColorProfile
src_format (Babl.Object) – the source Babl.Object format
dest_profile (Gimp.ColorProfile) – the destination Gimp.ColorProfile
dest_format (Babl.Object) – the destination Babl.Object format
rendering_intent (Gimp.ColorRenderingIntent) – the rendering intent
flags (Gimp.ColorTransformFlags) – transform flags

Returns:

the Gimp.ColorTransform, or None if there was an error.

Return type:

Gimp.ColorTransform or None

This function creates an color transform.

The color transform is determined exclusively by src_profile and dest_profile. The color spaces of src_format and dest_format are ignored, the formats are only used to decide between what pixel encodings to transform.

Note: this function used to return None if Gimp.ColorTransform.can_gegl_copy() returned True for src_profile and dest_profile. This is no longer the case because special care has to be taken not to perform multiple implicit color transforms caused by babl formats with color spaces. Now, it always returns a non-None transform and the code takes care of doing only exactly the requested color transform.

New in version 2.10.

classmethod new_proofing(src_profile, src_format, dest_profile, dest_format, proof_profile, proof_intent, display_intent, flags)¶

Parameters:

src_profile (Gimp.ColorProfile) – the source Gimp.ColorProfile
src_format (Babl.Object) – the source Babl.Object format
dest_profile (Gimp.ColorProfile) – the destination Gimp.ColorProfile
dest_format (Babl.Object) – the destination Babl.Object format
proof_profile (Gimp.ColorProfile) – the proof Gimp.ColorProfile
proof_intent (Gimp.ColorRenderingIntent) – the proof intent
display_intent (Gimp.ColorRenderingIntent) – the display intent
flags (Gimp.ColorTransformFlags) – transform flags

Returns:

the Gimp.ColorTransform, or None if there was an error.

Return type:

Gimp.ColorTransform or None

This function creates a simulation / proofing color transform.

See Gimp.ColorTransform.new() about the color spaces to transform between.

New in version 2.10.

process_buffer(src_buffer, src_rect, dest_buffer, dest_rect)¶

Parameters:

src_buffer (Gegl.Buffer) – source Gegl.Buffer
src_rect (Gegl.Rectangle) – rectangle in src_buffer
dest_buffer (Gegl.Buffer) – destination Gegl.Buffer
dest_rect (Gegl.Rectangle) – rectangle in dest_buffer

This function transforms buffer into another buffer.

See Gimp.ColorTransform.new(): only the pixel encoding of src_buffer's and dest_buffer's formats honored, their color spaces are ignored. The transform always takes place between the color spaces determined by self's color profiles.

New in version 2.10.

process_pixels(src_format, src_pixels, dest_format, dest_pixels, length)¶

Parameters:

src_format (Babl.Object) – Babl.Object format of src_pixels
src_pixels (object or None) – pointer to the source pixels
dest_format (Babl.Object) – Babl.Object format of dest_pixels
dest_pixels (object or None) – pointer to the destination pixels
length (int) – number of pixels to process

This function transforms a contiguous line of pixels.

See Gimp.ColorTransform.new(): only the pixel encoding of src_format and dest_format is honored, their color spaces are ignored. The transform always takes place between the color spaces determined by self's color profiles.

New in version 2.10.

Signal Details¶

Gimp.ColorTransform.signals.progress(color_transform, object)¶

Signal Name:

progress

Flags:

RUN_FIRST

Parameters:

color_transform (Gimp.ColorTransform) – The object which received the signal
object (float) –