vix v0.9.0

View Source Vix.Vips.MutableImage (vix v0.9.0)

Vips Mutable Image

See Vix.Vips.Image.mutate/2

Link to this section Summary

Types

t()

Represents a mutable instance of VipsImage

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get(mutable_image, name)

Returns metadata from the image

remove(mutable_image, name)

Remove a metadata item from an image.

set(mutable_image, name, type, value)

Create a metadata item on an image of the specifed type. Vix converts value to specified GType

update(mutable_image, name, value)

Set the value of existing metadata item on an image. Value is converted to match existing value GType

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %Vix.Vips.MutableImage{pid: pid()}

Represents a mutable instance of VipsImage

Link to this section Functions

Link to this function

child_spec(init_arg)

View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this function

get(mutable_image, name)

View Source

Specs

get(t(), String.t()) :: {:ok, term()} | {:error, term()}

Returns metadata from the image

Link to this function

remove(mutable_image, name)

View Source

Specs

remove(t(), String.t()) :: :ok | {:error, term()}

Remove a metadata item from an image.

Link to this function

set(mutable_image, name, type, value)

View Source

Specs

set(t(), String.t(), atom(), term()) :: :ok | {:error, term()}

Create a metadata item on an image of the specifed type. Vix converts value to specified GType

Supported GTypes

  • :gint
  • :guint
  • :gdouble
  • :gboolean
  • :gchararray
  • :VipsArrayInt
  • :VipsArrayDouble
  • :VipsArrayImage
  • :VipsRefString
  • :VipsBlob
  • :VipsImage
  • :VipsInterpolate
Link to this function

update(mutable_image, name, value)

View Source

Specs

update(t(), String.t(), term()) :: :ok | {:error, term()}

Set the value of existing metadata item on an image. Value is converted to match existing value GType