Gjsify LogoGjsify Logo

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

AUTO_ROWSTRIDE: number
BUFFER_MAX_ITERATORS: number
CH_BACK_CENTER: number
CH_BACK_LEFT: number
CH_BACK_RIGHT: number
CH_FRONT_CENTER: number
CH_FRONT_LEFT: number
CH_FRONT_LEFT_OF_CENTER: number
CH_FRONT_RIGHT: number
CH_FRONT_RIGHT_OF_CENTER: number
CH_LAYOUT_2POINT1: number
CH_LAYOUT_2_1: number
CH_LAYOUT_2_2: number
CH_LAYOUT_3POINT1: number
CH_LAYOUT_4POINT0: number
CH_LAYOUT_4POINT1: number
CH_LAYOUT_5POINT0: number
CH_LAYOUT_5POINT0_BACK: number
CH_LAYOUT_5POINT1: number
CH_LAYOUT_5POINT1_BACK: number
CH_LAYOUT_6POINT0: number
CH_LAYOUT_6POINT0_FRONT: number
CH_LAYOUT_6POINT1: number
CH_LAYOUT_6POINT1_BACK: number
CH_LAYOUT_6POINT1_FRONT: number
CH_LAYOUT_7POINT0: number
CH_LAYOUT_7POINT0_FRONT: number
CH_LAYOUT_7POINT1: number
CH_LAYOUT_7POINT1_WIDE: number
CH_LAYOUT_7POINT1_WIDE_BACK: number
CH_LAYOUT_HEXADECAGONAL: number
CH_LAYOUT_HEXAGONAL: number
CH_LAYOUT_NATIVE: number
CH_LAYOUT_OCTAGONAL: number
CH_LAYOUT_QUAD: number
CH_LAYOUT_STEREO: number
CH_LAYOUT_STEREO_DOWNMIX: number
CH_LAYOUT_SURROUND: number
CH_LOW_FREQUENCY: number
CH_LOW_FREQUENCY_2: number
CH_SIDE_LEFT: number
CH_SIDE_RIGHT: number
CH_STEREO_LEFT: number
CH_STEREO_RIGHT: number
CH_SURROUND_DIRECT_LEFT: number
CH_SURROUND_DIRECT_RIGHT: number
CH_TOP_BACK_CENTER: number
CH_TOP_BACK_LEFT: number
CH_TOP_BACK_RIGHT: number
CH_TOP_CENTER: number
CH_TOP_FRONT_CENTER: number
CH_TOP_FRONT_LEFT: number
CH_TOP_FRONT_RIGHT: number
CH_WIDE_LEFT: number
CH_WIDE_RIGHT: number
FLOAT_EPSILON: number
LOOKUP_MAX_ENTRIES: number
MAJOR_VERSION: number
MAX_AUDIO_CHANNELS: number
MICRO_VERSION: number
MINOR_VERSION: number
PARAM_NO_VALIDATE: number

Functions

  • cl_disable(): void
  • cl_init(): boolean
  • Initialize and enable OpenCL, calling this function again will re-enable OpenCL if it has been disabled.

    Returns boolean

  • cl_is_accelerated(): boolean
  • create_chain(ops: string, op_start: Gegl.Node, op_end: Gegl.Node, time: number, rel_dim: number, path_root: string): void
  • 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(ops: string, op_start: Gegl.Node, op_end: Gegl.Node, time: number, rel_dim: number, path_root: string): void
  • 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(): void
  • 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_name: string): any | null
  • 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: any): string | null
  • get_version(): [number, number, number]
  • This function fetches the version of the GEGL library being used by the running process.

    Returns [number, number, number]

  • graph_dump_outputs(node: Gegl.Node): void
  • has_operation(operation_type: string): boolean
  • init(argv: string[]): string[] | null
  • 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(): boolean
  • list_operations(): string[]
  • load_module_directory(path: string): void
  • Load all gegl modules found in the given directory.

    Parameters

    • path: string

      the directory to load modules from

    Returns void

  • 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

  • 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(name: string, nick: string, blurb: string, default_color_string: string, flags: GObject.ParamFlags): ParamSpec
  • 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

  • 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(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
  • 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

  • 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(name: string, nick: string, blurb: string, no_validate: boolean, null_ok: boolean, default_value: string, flags: GObject.ParamFlags): ParamSpec
  • 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

  • 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(pspec: ParamSpec, key_name: string): string
  • 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
  • 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

  • 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

  • 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(pspec: ParamSpec, key_name: string, value: string): void
  • param_spec_string(name: string, nick: string, blurb: string, no_validate: boolean, null_ok: boolean, default_value: string, flags: GObject.ParamFlags): ParamSpec
  • 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(name: string, nick: string, blurb: string, no_validate: boolean, null_ok: boolean, default_value: string, flags: GObject.ParamFlags): ParamSpec
  • 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

  • reset_stats(): void
  • Resets the cumulative data gathered by the #GeglStats object returned by #gegl_stats().

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method