add_mask

Description:

public bool add_mask (LayerMask mask)

Add a layer mask to the specified layer.

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'.

Parameters:

this	The layer to receive the mask.
mask	The mask to add to the layer.

Returns:

TRUE on success.