880 lines
51 KiB
XML
880 lines
51 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
|
|
|
|
<refentry id="libgimp-gimplayer">
|
|
<refmeta>
|
|
<refentrytitle role="top_of_page" id="libgimp-gimplayer.top_of_page">gimplayer</refentrytitle>
|
|
<manvolnum>3</manvolnum>
|
|
<refmiscinfo>LIBGIMP Library</refmiscinfo>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>gimplayer</refname>
|
|
<refpurpose>Operations on a single layer.</refpurpose>
|
|
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv id="libgimp-gimplayer.synopsis" role="synopsis">
|
|
<title role="synopsis.title">Synopsis</title>
|
|
|
|
<synopsis>
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-new">gimp_layer_new</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> width,
|
|
<link linkend="gint">gint</link> height,
|
|
<link linkend="GimpImageType">GimpImageType</link> type,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-new-from-drawable">gimp_layer_new_from_drawable</link> (<link linkend="gint32">gint32</link> drawable_ID,
|
|
<link linkend="gint32">gint32</link> dest_image_ID);
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-new-from-visible">gimp_layer_new_from_visible</link> (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> dest_image_ID,
|
|
const <link linkend="gchar">gchar</link> *name);
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-copy">gimp_layer_copy</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-scale">gimp_layer_scale</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> new_width,
|
|
<link linkend="gint">gint</link> new_height,
|
|
<link linkend="gboolean">gboolean</link> local_origin);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-scale-full">gimp_layer_scale_full</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> new_width,
|
|
<link linkend="gint">gint</link> new_height,
|
|
<link linkend="gboolean">gboolean</link> local_origin,
|
|
<link linkend="GimpInterpolationType">GimpInterpolationType</link> interpolation);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-resize">gimp_layer_resize</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> new_width,
|
|
<link linkend="gint">gint</link> new_height,
|
|
<link linkend="gint">gint</link> offx,
|
|
<link linkend="gint">gint</link> offy);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-resize-to-image-size">gimp_layer_resize_to_image_size</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-translate">gimp_layer_translate</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> offx,
|
|
<link linkend="gint">gint</link> offy);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-add-alpha">gimp_layer_add_alpha</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-flatten">gimp_layer_flatten</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-offsets">gimp_layer_set_offsets</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> offx,
|
|
<link linkend="gint">gint</link> offy);
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-create-mask">gimp_layer_create_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpAddMaskType">GimpAddMaskType</link> mask_type);
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-from-mask">gimp_layer_from_mask</link> (<link linkend="gint32">gint32</link> mask_ID);
|
|
<link linkend="gint32">gint32</link> <link linkend="gimp-layer-get-mask">gimp_layer_get_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-add-mask">gimp_layer_add_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint32">gint32</link> mask_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-remove-mask">gimp_layer_remove_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpMaskApplyMode">GimpMaskApplyMode</link> mode);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-lock-alpha">gimp_layer_get_lock_alpha</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-lock-alpha">gimp_layer_set_lock_alpha</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> lock_alpha);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-preserve-trans">gimp_layer_get_preserve_trans</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-preserve-trans">gimp_layer_set_preserve_trans</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> preserve_trans);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-apply-mask">gimp_layer_get_apply_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-apply-mask">gimp_layer_set_apply_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> apply_mask);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-show-mask">gimp_layer_get_show_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-show-mask">gimp_layer_set_show_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> show_mask);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-edit-mask">gimp_layer_get_edit_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-edit-mask">gimp_layer_set_edit_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> edit_mask);
|
|
<link linkend="gdouble">gdouble</link> <link linkend="gimp-layer-get-opacity">gimp_layer_get_opacity</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-opacity">gimp_layer_set_opacity</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> opacity);
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> <link linkend="gimp-layer-get-mode">gimp_layer_get_mode</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-mode">gimp_layer_set_mode</link> (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);
|
|
<link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-is-floating-sel">gimp_layer_is_floating_sel</link> (<link linkend="gint32">gint32</link> layer_ID);
|
|
</synopsis>
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<refsect1 id="libgimp-gimplayer.description" role="desc">
|
|
<title role="desc.title">Description</title>
|
|
<para>
|
|
Operations on a single layer.
|
|
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 id="libgimp-gimplayer.details" role="details">
|
|
<title role="details.title">Details</title>
|
|
<refsect2 id="gimp-layer-new" role="function">
|
|
<title>gimp_layer_new ()</title>
|
|
<indexterm zone="gimp-layer-new"><primary>gimp_layer_new</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_new (<link linkend="gint32">gint32</link> image_ID,
|
|
const <link linkend="gchar">gchar</link> *name,
|
|
<link linkend="gint">gint</link> width,
|
|
<link linkend="gint">gint</link> height,
|
|
<link linkend="GimpImageType">GimpImageType</link> type,
|
|
<link linkend="gdouble">gdouble</link> opacity,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);</programlisting>
|
|
<para>
|
|
Create a new layer.
|
|
</para>
|
|
<para>
|
|
This procedure creates a new layer with the specified width, height,
|
|
and type. Name, opacity, and mode are also supplied parameters. The
|
|
new layer still needs to be added to the image, as this is not
|
|
automatic. Add the new layer with the 'gimp_image_add_layer'
|
|
command. Other attributes such as layer mask modes, and offsets
|
|
should be set with explicit procedure calls.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The image to which to add the layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The layer name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>width</parameter> :</term>
|
|
<listitem><simpara> The layer width.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>height</parameter> :</term>
|
|
<listitem><simpara> The layer height.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>type</parameter> :</term>
|
|
<listitem><simpara> The layer type.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara> The layer opacity.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mode</parameter> :</term>
|
|
<listitem><simpara> The layer combination mode.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created layer.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-new-from-drawable" role="function">
|
|
<title>gimp_layer_new_from_drawable ()</title>
|
|
<indexterm zone="gimp-layer-new-from-drawable"><primary>gimp_layer_new_from_drawable</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_new_from_drawable (<link linkend="gint32">gint32</link> drawable_ID,
|
|
<link linkend="gint32">gint32</link> dest_image_ID);</programlisting>
|
|
<para>
|
|
Create a new layer by copying an existing drawable.
|
|
</para>
|
|
<para>
|
|
This procedure creates a new layer as a copy of the specified
|
|
drawable. The new layer still needs to be added to the image, as
|
|
this is not automatic. Add the new layer with the
|
|
<link linkend="gimp-image-add-layer"><function>gimp_image_add_layer()</function></link> command. Other attributes such as layer mask
|
|
modes, and offsets should be set with explicit procedure calls.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>drawable_ID</parameter> :</term>
|
|
<listitem><simpara> The source drawable from where the new layer is copied.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dest_image_ID</parameter> :</term>
|
|
<listitem><simpara> The destination image to which to add the layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly copied layer.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-new-from-visible" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_layer_new_from_visible ()</title>
|
|
<indexterm zone="gimp-layer-new-from-visible" role="GIMP 2.6"><primary>gimp_layer_new_from_visible</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_new_from_visible (<link linkend="gint32">gint32</link> image_ID,
|
|
<link linkend="gint32">gint32</link> dest_image_ID,
|
|
const <link linkend="gchar">gchar</link> *name);</programlisting>
|
|
<para>
|
|
Create a new layer from what is visible in an image.
|
|
</para>
|
|
<para>
|
|
This procedure creates a new layer from what is visible in the given
|
|
image. The new layer still needs to be added to the destination
|
|
image, as this is not automatic. Add the new layer with the
|
|
<link linkend="gimp-image-add-layer"><function>gimp_image_add_layer()</function></link> command. Other attributes such as layer mask
|
|
modes, and offsets should be set with explicit procedure calls.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>image_ID</parameter> :</term>
|
|
<listitem><simpara> The source image from where the content is copied.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>dest_image_ID</parameter> :</term>
|
|
<listitem><simpara> The destination image to which to add the layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>name</parameter> :</term>
|
|
<listitem><simpara> The layer name.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-layer-copy" role="function">
|
|
<title>gimp_layer_copy ()</title>
|
|
<indexterm zone="gimp-layer-copy"><primary>gimp_layer_copy</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_copy (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Copy a layer.
|
|
</para>
|
|
<para>
|
|
This procedure copies the specified layer and returns the copy. The
|
|
newly copied layer is for use within the original layer's image. It
|
|
should not be subsequently added to any other image.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer to copy.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly copied layer.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-scale" role="function">
|
|
<title>gimp_layer_scale ()</title>
|
|
<indexterm zone="gimp-layer-scale"><primary>gimp_layer_scale</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_scale (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> new_width,
|
|
<link linkend="gint">gint</link> new_height,
|
|
<link linkend="gboolean">gboolean</link> local_origin);</programlisting>
|
|
<para>
|
|
Scale the layer using the default interpolation method.
|
|
</para>
|
|
<para>
|
|
This procedure scales the layer so that its new width and height are
|
|
equal to the supplied parameters. The 'local-origin' parameter
|
|
specifies whether to scale from the center of the layer, or from the
|
|
image origin. This operation only works if the layer has been added
|
|
to an image. The default interpolation method is used for scaling.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>new_width</parameter> :</term>
|
|
<listitem><simpara> New layer width.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>new_height</parameter> :</term>
|
|
<listitem><simpara> New layer height.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>local_origin</parameter> :</term>
|
|
<listitem><simpara> Use a local origin (as opposed to the image origin).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-scale-full" role="function" condition="since:GIMP 2.6">
|
|
<title>gimp_layer_scale_full ()</title>
|
|
<indexterm zone="gimp-layer-scale-full" role="GIMP 2.6"><primary>gimp_layer_scale_full</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_scale_full (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> new_width,
|
|
<link linkend="gint">gint</link> new_height,
|
|
<link linkend="gboolean">gboolean</link> local_origin,
|
|
<link linkend="GimpInterpolationType">GimpInterpolationType</link> interpolation);</programlisting>
|
|
<para>
|
|
Scale the layer using a specific interpolation method.
|
|
</para>
|
|
<para>
|
|
This procedure scales the layer so that its new width and height are
|
|
equal to the supplied parameters. The 'local-origin' parameter
|
|
specifies whether to scale from the center of the layer, or from the
|
|
image origin. This operation only works if the layer has been added
|
|
to an image. This procedure allows you to specify the interpolation
|
|
method explicitly.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>new_width</parameter> :</term>
|
|
<listitem><simpara> New layer width.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>new_height</parameter> :</term>
|
|
<listitem><simpara> New layer height.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>local_origin</parameter> :</term>
|
|
<listitem><simpara> Use a local origin (as opposed to the image origin).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>interpolation</parameter> :</term>
|
|
<listitem><simpara> Type of interpolation.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.6
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-layer-resize" role="function">
|
|
<title>gimp_layer_resize ()</title>
|
|
<indexterm zone="gimp-layer-resize"><primary>gimp_layer_resize</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_resize (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> new_width,
|
|
<link linkend="gint">gint</link> new_height,
|
|
<link linkend="gint">gint</link> offx,
|
|
<link linkend="gint">gint</link> offy);</programlisting>
|
|
<para>
|
|
Resize the layer to the specified extents.
|
|
</para>
|
|
<para>
|
|
This procedure resizes the layer so that its new width and height
|
|
are equal to the supplied parameters. Offsets are also provided
|
|
which describe the position of the previous layer's content. This
|
|
operation only works if the layer has been added to an image.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>new_width</parameter> :</term>
|
|
<listitem><simpara> New layer width.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>new_height</parameter> :</term>
|
|
<listitem><simpara> New layer height.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>offx</parameter> :</term>
|
|
<listitem><simpara> x offset between upper left corner of old and new layers: (old - new).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>offy</parameter> :</term>
|
|
<listitem><simpara> y offset between upper left corner of old and new layers: (old - new).
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-resize-to-image-size" role="function">
|
|
<title>gimp_layer_resize_to_image_size ()</title>
|
|
<indexterm zone="gimp-layer-resize-to-image-size"><primary>gimp_layer_resize_to_image_size</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_resize_to_image_size (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Resize a layer to the image size.
|
|
</para>
|
|
<para>
|
|
This procedure resizes the layer so that it's new width and height
|
|
are equal to the width and height of its image container.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer to resize.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-translate" role="function">
|
|
<title>gimp_layer_translate ()</title>
|
|
<indexterm zone="gimp-layer-translate"><primary>gimp_layer_translate</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_translate (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> offx,
|
|
<link linkend="gint">gint</link> offy);</programlisting>
|
|
<para>
|
|
Translate the layer by the specified offsets.
|
|
</para>
|
|
<para>
|
|
This procedure translates the layer by the amounts specified in the
|
|
x and y arguments. These can be negative, and are considered offsets
|
|
from the current position. This command only works if the layer has
|
|
been added to an image. All additional layers contained in the image
|
|
which have the linked flag set to TRUE w ill also be translated by
|
|
the specified offsets.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>offx</parameter> :</term>
|
|
<listitem><simpara> Offset in x direction.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>offy</parameter> :</term>
|
|
<listitem><simpara> Offset in y direction.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-add-alpha" role="function">
|
|
<title>gimp_layer_add_alpha ()</title>
|
|
<indexterm zone="gimp-layer-add-alpha"><primary>gimp_layer_add_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_add_alpha (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Add an alpha channel to the layer if it doesn't already have one.
|
|
</para>
|
|
<para>
|
|
This procedure adds an additional component to the specified layer
|
|
if it does not already possess an alpha channel. An alpha channel
|
|
makes it possible to clear and erase to transparency, instead of the
|
|
background color. This transforms layers of type RGB to RGBA, GRAY
|
|
to GRAYA, and INDEXED to INDEXEDA.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-flatten" role="function" condition="since:GIMP 2.4">
|
|
<title>gimp_layer_flatten ()</title>
|
|
<indexterm zone="gimp-layer-flatten" role="GIMP 2.4"><primary>gimp_layer_flatten</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_flatten (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Remove the alpha channel from the layer if it has one.
|
|
</para>
|
|
<para>
|
|
This procedure removes the alpha channel from a layer, blending all
|
|
(partially) transparent pixels in the layer against the background
|
|
color. This transforms layers of type RGBA to RGB, GRAYA to GRAY,
|
|
and INDEXEDA to INDEXED.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.4
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-layer-set-offsets" role="function">
|
|
<title>gimp_layer_set_offsets ()</title>
|
|
<indexterm zone="gimp-layer-set-offsets"><primary>gimp_layer_set_offsets</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_offsets (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint">gint</link> offx,
|
|
<link linkend="gint">gint</link> offy);</programlisting>
|
|
<para>
|
|
Set the layer offsets.
|
|
</para>
|
|
<para>
|
|
This procedure sets the offsets for the specified layer. The offsets
|
|
are relative to the image origin and can be any values. This
|
|
operation is valid only on layers which have been added to an image.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>offx</parameter> :</term>
|
|
<listitem><simpara> Offset in x direction.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>offy</parameter> :</term>
|
|
<listitem><simpara> Offset in y direction.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-create-mask" role="function">
|
|
<title>gimp_layer_create_mask ()</title>
|
|
<indexterm zone="gimp-layer-create-mask"><primary>gimp_layer_create_mask</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_create_mask (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpAddMaskType">GimpAddMaskType</link> mask_type);</programlisting>
|
|
<para>
|
|
Create a layer mask for the specified specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure creates a layer mask for the specified layer. Layer
|
|
masks serve as an additional alpha channel for a layer. A number of
|
|
different types of masks are allowed for initialisation: completely
|
|
white masks (which will leave the layer fully visible), completely
|
|
black masks (which will give the layer complete transparency, the
|
|
layer's already existing alpha channel (which will leave the layer
|
|
fully visible, but which may be more useful than a white mask), the
|
|
current selection or a grayscale copy of the layer. The layer mask
|
|
still needs to be added to the layer. This can be done with a call
|
|
to <link linkend="gimp-layer-add-mask"><function>gimp_layer_add_mask()</function></link>.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer to which to add the mask.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mask_type</parameter> :</term>
|
|
<listitem><simpara> The type of mask.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The newly created mask.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-from-mask" role="function" condition="since:GIMP 2.2">
|
|
<title>gimp_layer_from_mask ()</title>
|
|
<indexterm zone="gimp-layer-from-mask" role="GIMP 2.2"><primary>gimp_layer_from_mask</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_from_mask (<link linkend="gint32">gint32</link> mask_ID);</programlisting>
|
|
<para>
|
|
Get the specified mask's layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the specified mask's layer , or -1 if none
|
|
exists.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>mask_ID</parameter> :</term>
|
|
<listitem><simpara> Mask for which to return the layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The mask's layer.
|
|
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist><para role="since">Since GIMP 2.2
|
|
</para></refsect2>
|
|
<refsect2 id="gimp-layer-get-mask" role="function">
|
|
<title>gimp_layer_get_mask ()</title>
|
|
<indexterm zone="gimp-layer-get-mask"><primary>gimp_layer_get_mask</primary></indexterm><programlisting><link linkend="gint32">gint32</link> gimp_layer_get_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the specified layer's mask if it exists.
|
|
</para>
|
|
<para>
|
|
This procedure returns the specified layer's mask, or -1 if none
|
|
exists.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer mask.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-add-mask" role="function">
|
|
<title>gimp_layer_add_mask ()</title>
|
|
<indexterm zone="gimp-layer-add-mask"><primary>gimp_layer_add_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_add_mask (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gint32">gint32</link> mask_ID);</programlisting>
|
|
<para>
|
|
Add a layer mask to the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure adds a layer mask to the specified layer. Layer masks
|
|
serve as an additional alpha channel for a layer. This procedure
|
|
will fail if a number of prerequisites aren't met. The layer cannot
|
|
already have a layer mask. The specified mask must exist and have
|
|
the same dimensions as the layer. The layer must have been created
|
|
for use with the specified image and the mask must have been created
|
|
with the procedure 'gimp-layer-create-mask'.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer to receive the mask.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mask_ID</parameter> :</term>
|
|
<listitem><simpara> The mask to add to the layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-remove-mask" role="function">
|
|
<title>gimp_layer_remove_mask ()</title>
|
|
<indexterm zone="gimp-layer-remove-mask"><primary>gimp_layer_remove_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_remove_mask (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpMaskApplyMode">GimpMaskApplyMode</link> mode);</programlisting>
|
|
<para>
|
|
Remove the specified layer mask from the layer.
|
|
</para>
|
|
<para>
|
|
This procedure removes the specified layer mask from the layer. If
|
|
the mask doesn't exist, an error is returned.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer from which to remove mask.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mode</parameter> :</term>
|
|
<listitem><simpara> Removal mode.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-get-lock-alpha" role="function">
|
|
<title>gimp_layer_get_lock_alpha ()</title>
|
|
<indexterm zone="gimp-layer-get-lock-alpha"><primary>gimp_layer_get_lock_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_lock_alpha (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the lock alpha channel setting of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the specified layer's lock alpha channel
|
|
setting.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer's lock alpha channel setting.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-set-lock-alpha" role="function">
|
|
<title>gimp_layer_set_lock_alpha ()</title>
|
|
<indexterm zone="gimp-layer-set-lock-alpha"><primary>gimp_layer_set_lock_alpha</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_lock_alpha (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> lock_alpha);</programlisting>
|
|
<para>
|
|
Set the lock alpha channel setting of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the specified layer's lock alpha channel
|
|
setting.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>lock_alpha</parameter> :</term>
|
|
<listitem><simpara> The new layer's lock alpha channel setting.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-get-preserve-trans" role="function" condition="deprecated:">
|
|
<title>gimp_layer_get_preserve_trans ()</title>
|
|
<indexterm zone="gimp-layer-get-preserve-trans" role="deprecated"><primary>gimp_layer_get_preserve_trans</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_preserve_trans (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<warning><para><literal>gimp_layer_get_preserve_trans</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
|
<para>
|
|
This procedure is deprecated! Use <link linkend="gimp-layer-get-lock-alpha"><function>gimp_layer_get_lock_alpha()</function></link> instead.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer's preserve transperancy setting.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-set-preserve-trans" role="function" condition="deprecated:">
|
|
<title>gimp_layer_set_preserve_trans ()</title>
|
|
<indexterm zone="gimp-layer-set-preserve-trans" role="deprecated"><primary>gimp_layer_set_preserve_trans</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_preserve_trans (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> preserve_trans);</programlisting>
|
|
<warning><para><literal>gimp_layer_set_preserve_trans</literal> is deprecated and should not be used in newly-written code.</para></warning>
|
|
<para>
|
|
This procedure is deprecated! Use <link linkend="gimp-layer-set-lock-alpha"><function>gimp_layer_set_lock_alpha()</function></link> instead.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>preserve_trans</parameter> :</term>
|
|
<listitem><simpara> The new layer's preserve transperancy setting.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-get-apply-mask" role="function">
|
|
<title>gimp_layer_get_apply_mask ()</title>
|
|
<indexterm zone="gimp-layer-get-apply-mask"><primary>gimp_layer_get_apply_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_apply_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the apply mask setting of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the specified layer's apply mask setting. If
|
|
the value is TRUE, then the layer mask for this layer is currently
|
|
being composited with the layer's alpha channel.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer's apply mask setting.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-set-apply-mask" role="function">
|
|
<title>gimp_layer_set_apply_mask ()</title>
|
|
<indexterm zone="gimp-layer-set-apply-mask"><primary>gimp_layer_set_apply_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_apply_mask (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> apply_mask);</programlisting>
|
|
<para>
|
|
Set the apply mask setting of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the specified layer's apply mask setting. This
|
|
controls whether the layer's mask is currently affecting the alpha
|
|
channel. If there is no layer mask, this function will return an
|
|
error.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>apply_mask</parameter> :</term>
|
|
<listitem><simpara> The new layer's apply mask setting.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-get-show-mask" role="function">
|
|
<title>gimp_layer_get_show_mask ()</title>
|
|
<indexterm zone="gimp-layer-get-show-mask"><primary>gimp_layer_get_show_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_show_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the show mask setting of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the specified layer's show mask setting. This
|
|
controls whether the layer or its mask is visible. TRUE indicates
|
|
that the mask should be visible. If the layer has no mask, then this
|
|
function returns an error.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer's show mask setting.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-set-show-mask" role="function">
|
|
<title>gimp_layer_set_show_mask ()</title>
|
|
<indexterm zone="gimp-layer-set-show-mask"><primary>gimp_layer_set_show_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_show_mask (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> show_mask);</programlisting>
|
|
<para>
|
|
Set the show mask setting of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the specified layer's show mask setting. This
|
|
controls whether the layer or its mask is visible. TRUE indicates
|
|
that the mask should be visible. If there is no layer mask, this
|
|
function will return an error.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>show_mask</parameter> :</term>
|
|
<listitem><simpara> The new layer's show mask setting.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-get-edit-mask" role="function">
|
|
<title>gimp_layer_get_edit_mask ()</title>
|
|
<indexterm zone="gimp-layer-get-edit-mask"><primary>gimp_layer_get_edit_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_edit_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the edit mask setting of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the specified layer's edit mask setting. If
|
|
the value is TRUE, then the layer mask for this layer is currently
|
|
active, and not the layer.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer's edit mask setting.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-set-edit-mask" role="function">
|
|
<title>gimp_layer_set_edit_mask ()</title>
|
|
<indexterm zone="gimp-layer-set-edit-mask"><primary>gimp_layer_set_edit_mask</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_edit_mask (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gboolean">gboolean</link> edit_mask);</programlisting>
|
|
<para>
|
|
Set the edit mask setting of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the specified layer's edit mask setting. This
|
|
controls whether the layer or it's mask is currently active for
|
|
editing. If the specified layer has no layer mask, then this
|
|
procedure will return an error.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>edit_mask</parameter> :</term>
|
|
<listitem><simpara> The new layer's edit mask setting.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-get-opacity" role="function">
|
|
<title>gimp_layer_get_opacity ()</title>
|
|
<indexterm zone="gimp-layer-get-opacity"><primary>gimp_layer_get_opacity</primary></indexterm><programlisting><link linkend="gdouble">gdouble</link> gimp_layer_get_opacity (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the opacity of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the specified layer's opacity.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer opacity.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-set-opacity" role="function">
|
|
<title>gimp_layer_set_opacity ()</title>
|
|
<indexterm zone="gimp-layer-set-opacity"><primary>gimp_layer_set_opacity</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_opacity (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="gdouble">gdouble</link> opacity);</programlisting>
|
|
<para>
|
|
Set the opacity of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the specified layer's opacity.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>opacity</parameter> :</term>
|
|
<listitem><simpara> The new layer opacity.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-get-mode" role="function">
|
|
<title>gimp_layer_get_mode ()</title>
|
|
<indexterm zone="gimp-layer-get-mode"><primary>gimp_layer_get_mode</primary></indexterm><programlisting><link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> gimp_layer_get_mode (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Get the combination mode of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure returns the specified layer's combination mode.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The layer combination mode.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-set-mode" role="function">
|
|
<title>gimp_layer_set_mode ()</title>
|
|
<indexterm zone="gimp-layer-set-mode"><primary>gimp_layer_set_mode</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_mode (<link linkend="gint32">gint32</link> layer_ID,
|
|
<link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);</programlisting>
|
|
<para>
|
|
Set the combination mode of the specified layer.
|
|
</para>
|
|
<para>
|
|
This procedure sets the specified layer's combination mode.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><parameter>mode</parameter> :</term>
|
|
<listitem><simpara> The new layer combination mode.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
<refsect2 id="gimp-layer-is-floating-sel" role="function">
|
|
<title>gimp_layer_is_floating_sel ()</title>
|
|
<indexterm zone="gimp-layer-is-floating-sel"><primary>gimp_layer_is_floating_sel</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gimp_layer_is_floating_sel (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
|
|
<para>
|
|
Is the specified layer a floating selection?
|
|
</para>
|
|
<para>
|
|
This procedure returns whether the layer is a floating selection.
|
|
Floating selections are special cases of layers which are attached
|
|
to a specific drawable.</para>
|
|
<para>
|
|
|
|
</para><variablelist role="params">
|
|
<varlistentry><term><parameter>layer_ID</parameter> :</term>
|
|
<listitem><simpara> The layer.
|
|
</simpara></listitem></varlistentry>
|
|
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if the layer is a floating selection.
|
|
</simpara></listitem></varlistentry>
|
|
</variablelist></refsect2>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
|
|
</refentry>
|