Namespace Gegl

Index

Enumerations

Variables

Const AUTO_ROWSTRIDE

AUTO_ROWSTRIDE: number

Const BUFFER_MAX_ITERATORS

BUFFER_MAX_ITERATORS: number

Const CH_BACK_CENTER

CH_BACK_CENTER: number

Const CH_BACK_LEFT

CH_BACK_LEFT: number

Const CH_BACK_RIGHT

CH_BACK_RIGHT: number

Const CH_FRONT_CENTER

CH_FRONT_CENTER: number

Const CH_FRONT_LEFT

CH_FRONT_LEFT: number

Const CH_FRONT_LEFT_OF_CENTER

CH_FRONT_LEFT_OF_CENTER: number

Const CH_FRONT_RIGHT

CH_FRONT_RIGHT: number

Const CH_FRONT_RIGHT_OF_CENTER

CH_FRONT_RIGHT_OF_CENTER: number

Const CH_LAYOUT_2POINT1

CH_LAYOUT_2POINT1: number

Const CH_LAYOUT_2_1

CH_LAYOUT_2_1: number

Const CH_LAYOUT_2_2

CH_LAYOUT_2_2: number

Const CH_LAYOUT_3POINT1

CH_LAYOUT_3POINT1: number

Const CH_LAYOUT_4POINT0

CH_LAYOUT_4POINT0: number

Const CH_LAYOUT_4POINT1

CH_LAYOUT_4POINT1: number

Const CH_LAYOUT_5POINT0

CH_LAYOUT_5POINT0: number

Const CH_LAYOUT_5POINT0_BACK

CH_LAYOUT_5POINT0_BACK: number

Const CH_LAYOUT_5POINT1

CH_LAYOUT_5POINT1: number

Const CH_LAYOUT_5POINT1_BACK

CH_LAYOUT_5POINT1_BACK: number

Const CH_LAYOUT_6POINT0

CH_LAYOUT_6POINT0: number

Const CH_LAYOUT_6POINT0_FRONT

CH_LAYOUT_6POINT0_FRONT: number

Const CH_LAYOUT_6POINT1

CH_LAYOUT_6POINT1: number

Const CH_LAYOUT_6POINT1_BACK

CH_LAYOUT_6POINT1_BACK: number

Const CH_LAYOUT_6POINT1_FRONT

CH_LAYOUT_6POINT1_FRONT: number

Const CH_LAYOUT_7POINT0

CH_LAYOUT_7POINT0: number

Const CH_LAYOUT_7POINT0_FRONT

CH_LAYOUT_7POINT0_FRONT: number

Const CH_LAYOUT_7POINT1

CH_LAYOUT_7POINT1: number

Const CH_LAYOUT_7POINT1_WIDE

CH_LAYOUT_7POINT1_WIDE: number

Const CH_LAYOUT_7POINT1_WIDE_BACK

CH_LAYOUT_7POINT1_WIDE_BACK: number

Const CH_LAYOUT_HEXADECAGONAL

CH_LAYOUT_HEXADECAGONAL: number

Const CH_LAYOUT_HEXAGONAL

CH_LAYOUT_HEXAGONAL: number

Const CH_LAYOUT_NATIVE

CH_LAYOUT_NATIVE: number

Const CH_LAYOUT_OCTAGONAL

CH_LAYOUT_OCTAGONAL: number

Const CH_LAYOUT_QUAD

CH_LAYOUT_QUAD: number

Const CH_LAYOUT_STEREO

CH_LAYOUT_STEREO: number

Const CH_LAYOUT_STEREO_DOWNMIX

CH_LAYOUT_STEREO_DOWNMIX: number

Const CH_LAYOUT_SURROUND

CH_LAYOUT_SURROUND: number

Const CH_LOW_FREQUENCY

CH_LOW_FREQUENCY: number

Const CH_LOW_FREQUENCY_2

CH_LOW_FREQUENCY_2: number

Const CH_SIDE_LEFT

CH_SIDE_LEFT: number

Const CH_SIDE_RIGHT

CH_SIDE_RIGHT: number

Const CH_STEREO_LEFT

CH_STEREO_LEFT: number

Const CH_STEREO_RIGHT

CH_STEREO_RIGHT: number

Const CH_SURROUND_DIRECT_LEFT

CH_SURROUND_DIRECT_LEFT: number

Const CH_SURROUND_DIRECT_RIGHT

CH_SURROUND_DIRECT_RIGHT: number

Const CH_TOP_BACK_CENTER

CH_TOP_BACK_CENTER: number

Const CH_TOP_BACK_LEFT

CH_TOP_BACK_LEFT: number

Const CH_TOP_BACK_RIGHT

CH_TOP_BACK_RIGHT: number

Const CH_TOP_CENTER

CH_TOP_CENTER: number

Const CH_TOP_FRONT_CENTER

CH_TOP_FRONT_CENTER: number

Const CH_TOP_FRONT_LEFT

CH_TOP_FRONT_LEFT: number

Const CH_TOP_FRONT_RIGHT

CH_TOP_FRONT_RIGHT: number

Const CH_WIDE_LEFT

CH_WIDE_LEFT: number

Const CH_WIDE_RIGHT

CH_WIDE_RIGHT: number

Const FLOAT_EPSILON

FLOAT_EPSILON: number

Const LOOKUP_MAX_ENTRIES

LOOKUP_MAX_ENTRIES: number

Const MAJOR_VERSION

MAJOR_VERSION: number

Const MAX_AUDIO_CHANNELS

MAX_AUDIO_CHANNELS: number

Const MICRO_VERSION

MICRO_VERSION: number

Const MINOR_VERSION

MINOR_VERSION: number

Const PARAM_NO_VALIDATE

PARAM_NO_VALIDATE: number

Functions

cl_disable

cl_disable(): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:154
Disable OpenCL

Returns void

cl_init

cl_init(): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:159
Initialize and enable OpenCL, calling this function again will re-enable OpenCL if it has been disabled.

Returns boolean

cl_is_accelerated

cl_is_accelerated(): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:163
Check if OpenCL is enabled.

Returns boolean

config

config(): Gegl.Config

- Defined in @types/Gjs/Gegl-0.3.d.ts:168
Returns a GeglConfig object with properties that can be manipulated to control GEGLs behavior.

Returns Gegl.Config

create_chain

create_chain(ops: string, op_start: Gegl.Node, op_end: Gegl.Node, time: number, rel_dim: number, path_root: string): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:178
Create a node chain from an unparsed commandline string.

Parameters
- ops: string
  
  an argv style, NULL terminated array of arguments
- op_start: Gegl.Node
  
  node to pass in as input of chain
- op_end: Gegl.Node
  
  node to get processed data
- time: number
  
  the time to use for interpolatino of keyframed values
- rel_dim: number
  
  relative dimension to scale rel suffixed values by
- path_root: string
  
  path in filesystem to use as relative root
Returns void

create_chain_argv

create_chain_argv(ops: string, op_start: Gegl.Node, op_end: Gegl.Node, time: number, rel_dim: number, path_root: string): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:188
Create a node chain from argv style list of op data.

Parameters
- ops: string
  
  an argv style, NULL terminated array of arguments
- op_start: Gegl.Node
  
  node to pass in as input of chain
- op_end: Gegl.Node
  
  node to get processed data
- time: number
  
  the time to use for interpolatino of keyframed values
- rel_dim: number
  
  relative dimension to scale rel suffixed values by
- path_root: string
  
  path in filesystem to use as relative root
Returns void

exit

exit(): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:194
Call this function when you're done using GEGL. It will clean up caches and write/dump debug information if the correct debug flags are set.

Returns void

format

format(format_name: string): any | null

- Defined in @types/Gjs/Gegl-0.3.d.ts:200
Returns a value sutable to pass to the GeglBuffer constructor or any other property that expects a Babl format.

Parameters
- format_name: string
  
  A Babl format name, e.g. "RGBA float"
Returns any | null

format_get_name

format_get_name(format: any): string | null

- Defined in @types/Gjs/Gegl-0.3.d.ts:201
Parameters
- format: any
Returns string | null

get_version

get_version(): [number, number, number]

- Defined in @types/Gjs/Gegl-0.3.d.ts:206
This function fetches the version of the GEGL library being used by the running process.

Returns [number, number, number]

graph_dump_outputs

graph_dump_outputs(node: Gegl.Node): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:211
Dump the bounds and format of each node in the graph to stdout.

Parameters
- node: Gegl.Node
  
  The final node of the graph
Returns void

graph_dump_request

graph_dump_request(node: Gegl.Node, roi: Gegl.Rectangle): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:218
Dump the region that will be rendered for each node to fulfill the request.

Parameters
- node: Gegl.Node
  
  The final node of the graph
- roi: Gegl.Rectangle
  
  The request rectangle
Returns void

has_operation

has_operation(operation_type: string): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:219
Parameters
- operation_type: string
Returns boolean

init

init(argv: string[]): string[] | null

- Defined in @types/Gjs/Gegl-0.3.d.ts:232
Call this function before using any other GEGL functions. It will initialize everything needed to operate GEGL and parses some standard command line options. argc and argv are adjusted accordingly so your own code will never see those standard arguments.

Note that there is an alternative way to initialize GEGL: if you are calling g_option_context_parse() with the option group returned by #gegl_get_option_group(), you don't have to call #gegl_init().

Parameters
- argv: string[]
  
  a pointer to the array of command line arguments.
Returns string[] | null

is_main_thread

is_main_thread(): boolean

- Defined in @types/Gjs/Gegl-0.3.d.ts:233
Returns boolean

list_operations

list_operations(): string[]

- Defined in @types/Gjs/Gegl-0.3.d.ts:234
Returns string[]

load_module_directory

load_module_directory(path: string): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:239
Load all gegl modules found in the given directory.

Parameters
- path: string
  
  the directory to load modules from
Returns void

param_spec_audio_fragment

param_spec_audio_fragment(name: string, nick: string, blurb: string, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:247
Creates a new #GParamSpec instance specifying a #GeglAudioFragment property.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_color

param_spec_color(name: string, nick: string, blurb: string, default_color: Gegl.Color, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:256
Creates a new #GParamSpec instance specifying a #GeglColor property.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- default_color: Gegl.Color
  
  the default value for the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_color_from_string

param_spec_color_from_string(name: string, nick: string, blurb: string, default_color_string: string, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:265
Creates a new #GParamSpec instance specifying a #GeglColor property.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- default_color_string: string
  
  the default value for the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_color_get_default

param_spec_color_get_default(self: ParamSpec): Gegl.Color

- Defined in @types/Gjs/Gegl-0.3.d.ts:270
Get the default color value of the param spec

Parameters
- self: ParamSpec
  
  a #GeglColor #GParamSpec
Returns Gegl.Color

param_spec_curve

param_spec_curve(name: string, nick: string, blurb: string, default_curve: Gegl.Curve, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:279
Creates a new #GParamSpec instance specifying a #GeglCurve property.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- default_curve: Gegl.Curve
  
  the default value for the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_double

param_spec_double(name: string, nick: string, blurb: string, minimum: number, maximum: number, default_value: number, ui_minimum: number, ui_maximum: number, ui_gamma: number, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:293
Creates a new #GeglParamSpecDouble instance.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- minimum: number
  
  minimum value for the property specified
- maximum: number
  
  maximum value for the property specified
- default_value: number
  
  default value for the property specified
- ui_minimum: number
  
  minimum value a user should be allowed to input
- ui_maximum: number
  
  maximum value a user should be allowed to input
- ui_gamma: number
  
  the gamma that should be used when adjusting the value
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_enum

param_spec_enum(name: string, nick: string, blurb: string, enum_type: GType<unknown>, default_value: number, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:303
Creates a new #GeglParamSpecEnum instance.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- enum_type: GType<unknown>
  
  the enum type to get valid values from
- default_value: number
  
  default value for the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_file_path

param_spec_file_path(name: string, nick: string, blurb: string, no_validate: boolean, null_ok: boolean, default_value: string, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:314
Creates a new #GeglParamSpecFilePath instance.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- no_validate: boolean
  
  true if the string should be validated with g_utf8_validate
- null_ok: boolean
  
  true if the string can be NULL
- default_value: string
  
  default value for the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_format

param_spec_format(name: string, nick: string, blurb: string, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:322
Creates a new #GeglParamSpecFormat instance specifying a Babl format.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_get_property_key

param_spec_get_property_key(pspec: ParamSpec, key_name: string): string

- Defined in @types/Gjs/Gegl-0.3.d.ts:323
Parameters
- pspec: ParamSpec
- key_name: string
Returns string

param_spec_int

param_spec_int(name: string, nick: string, blurb: string, minimum: number, maximum: number, default_value: number, ui_minimum: number, ui_maximum: number, ui_gamma: number, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:337
Creates a new #GeglParamSpecInt instance.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- minimum: number
  
  minimum value for the property specified
- maximum: number
  
  maximum value for the property specified
- default_value: number
  
  default value for the property specified
- ui_minimum: number
  
  minimum value a user should be allowed to input
- ui_maximum: number
  
  maximum value a user should be allowed to input
- ui_gamma: number
  
  the gamma that should be used when adjusting the value
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_path

param_spec_path(name: string, nick: string, blurb: string, default_path: Gegl.Path, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:346
Creates a new #GParamSpec instance specifying a #GeglPath property.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- default_path: Gegl.Path
  
  the default value for the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_seed

param_spec_seed(name: string, nick: string, blurb: string, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:354
Creates a new #GeglParamSpecSeed instance specifying an integer random seed.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_set_property_key

param_spec_set_property_key(pspec: ParamSpec, key_name: string, value: string): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:355
Parameters
- pspec: ParamSpec
- key_name: string
- value: string
Returns void

param_spec_string

param_spec_string(name: string, nick: string, blurb: string, no_validate: boolean, null_ok: boolean, default_value: string, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:366
Creates a new #GeglParamSpecString instance.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- no_validate: boolean
  
  true if the string should be validated with g_utf8_validate
- null_ok: boolean
  
  true if the string can be NULL
- default_value: string
  
  default value for the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

param_spec_uri

param_spec_uri(name: string, nick: string, blurb: string, no_validate: boolean, null_ok: boolean, default_value: string, flags: GObject.ParamFlags): ParamSpec

- Defined in @types/Gjs/Gegl-0.3.d.ts:377
Creates a new #GeglParamSpecUri instance.

Parameters
- name: string
  
  canonical name of the property specified
- nick: string
  
  nick name for the property specified
- blurb: string
  
  description of the property specified
- no_validate: boolean
  
  true if the string should be validated with g_utf8_validate
- null_ok: boolean
  
  true if the string can be NULL
- default_value: string
  
  default value for the property specified
- flags: GObject.ParamFlags
  
  flags for the property specified
Returns ParamSpec

rectangle_infinite_plane

rectangle_infinite_plane(): Gegl.Rectangle

- Defined in @types/Gjs/Gegl-0.3.d.ts:381
Returns a GeglRectangle that represents an infininte plane.

Returns Gegl.Rectangle

reset_stats

reset_stats(): void

- Defined in @types/Gjs/Gegl-0.3.d.ts:386
Resets the cumulative data gathered by the #GeglStats object returned by #gegl_stats().

Returns void

serialize

serialize(start: Gegl.Node, end: Gegl.Node, basepath: string, serialize_flags: Gegl.SerializeFlag): string

- Defined in @types/Gjs/Gegl-0.3.d.ts:387
Parameters
- start: Gegl.Node
- end: Gegl.Node
- basepath: string
- serialize_flags: Gegl.SerializeFlag
Returns string

stats

stats(): Gegl.Stats

- Defined in @types/Gjs/Gegl-0.3.d.ts:392
Returns a GeglStats object with properties that can be read to monitor GEGL statistics.

Returns Gegl.Stats

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const AUTO_ROWSTRIDE

Const BUFFER_MAX_ITERATORS

Const CH_BACK_CENTER

Const CH_BACK_LEFT

Const CH_BACK_RIGHT

Const CH_FRONT_CENTER

Const CH_FRONT_LEFT

Const CH_FRONT_LEFT_OF_CENTER

Const CH_FRONT_RIGHT

Const CH_FRONT_RIGHT_OF_CENTER

Const CH_LAYOUT_2POINT1

Const CH_LAYOUT_2_1

Const CH_LAYOUT_2_2

Const CH_LAYOUT_3POINT1

Const CH_LAYOUT_4POINT0

Const CH_LAYOUT_4POINT1

Const CH_LAYOUT_5POINT0

Const CH_LAYOUT_5POINT0_BACK

Const CH_LAYOUT_5POINT1

Const CH_LAYOUT_5POINT1_BACK

Const CH_LAYOUT_6POINT0

Const CH_LAYOUT_6POINT0_FRONT

Const CH_LAYOUT_6POINT1

Const CH_LAYOUT_6POINT1_BACK

Const CH_LAYOUT_6POINT1_FRONT

Const CH_LAYOUT_7POINT0

Const CH_LAYOUT_7POINT0_FRONT

Const CH_LAYOUT_7POINT1

Const CH_LAYOUT_7POINT1_WIDE

Const CH_LAYOUT_7POINT1_WIDE_BACK

Const CH_LAYOUT_HEXADECAGONAL

Const CH_LAYOUT_HEXAGONAL

Const CH_LAYOUT_NATIVE

Const CH_LAYOUT_OCTAGONAL

Const CH_LAYOUT_QUAD

Const CH_LAYOUT_STEREO

Const CH_LAYOUT_STEREO_DOWNMIX

Const CH_LAYOUT_SURROUND

Const CH_LOW_FREQUENCY

Const CH_LOW_FREQUENCY_2

Const CH_SIDE_LEFT

Const CH_SIDE_RIGHT

Const CH_STEREO_LEFT

Const CH_STEREO_RIGHT

Const CH_SURROUND_DIRECT_LEFT

Const CH_SURROUND_DIRECT_RIGHT

Const CH_TOP_BACK_CENTER

Const CH_TOP_BACK_LEFT

Const CH_TOP_BACK_RIGHT

Const CH_TOP_CENTER

Const CH_TOP_FRONT_CENTER

Const CH_TOP_FRONT_LEFT

Const CH_TOP_FRONT_RIGHT

Const CH_WIDE_LEFT

Const CH_WIDE_RIGHT

Const FLOAT_EPSILON

Const LOOKUP_MAX_ENTRIES

Const MAJOR_VERSION

Const MAX_AUDIO_CHANNELS

Const MICRO_VERSION

Const MINOR_VERSION

Const PARAM_NO_VALIDATE

Functions

cl_disable

Returns void

cl_init

Returns boolean

cl_is_accelerated

Returns boolean

config

Returns Gegl.Config

create_chain

Parameters