GimpPaintOptions

GimpPaintOptions

Synopsis

#define             GIMP_PAINT_OPTIONS_CONTEXT_MASK
struct              GimpJitterOptions;
struct              GimpFadeOptions;
struct              GimpGradientOptions;
struct              GimpSmoothingOptions;
                    GimpPaintOptions;
GimpPaintOptions *  gimp_paint_options_new              (GimpPaintInfo *paint_info);
gdouble             gimp_paint_options_get_fade         (GimpPaintOptions *paint_options,
                                                         GimpImage *image,
                                                         gdouble pixel_dist);
gdouble             gimp_paint_options_get_jitter       (GimpPaintOptions *paint_options,
                                                         GimpImage *image);
gboolean            gimp_paint_options_get_gradient_color
                                                        (GimpPaintOptions *paint_options,
                                                         GimpImage *image,
                                                         gdouble grad_point,
                                                         gdouble pixel_dist,
                                                         GimpRGB *color);
GimpBrushApplicationMode gimp_paint_options_get_brush_mode
                                                        (GimpPaintOptions *paint_options);
void                gimp_paint_options_copy_brush_props (GimpPaintOptions *src,
                                                         GimpPaintOptions *dest);
void                gimp_paint_options_copy_dynamics_props
                                                        (GimpPaintOptions *src,
                                                         GimpPaintOptions *dest);
void                gimp_paint_options_copy_gradient_props
                                                        (GimpPaintOptions *src,
                                                         GimpPaintOptions *dest);

Object Hierarchy

  GObject
   +----GimpObject
         +----GimpViewable
               +----GimpContext
                     +----GimpToolOptions
                           +----GimpPaintOptions
                                 +----GimpAirbrushOptions
                                 +----GimpBlendOptions
                                 +----GimpBucketFillOptions
                                 +----GimpSourceOptions
                                 +----GimpConvolveOptions
                                 +----GimpDodgeBurnOptions
                                 +----GimpEraserOptions
                                 +----GimpInkOptions
                                 +----GimpPencilOptions
                                 +----GimpSmudgeOptions

Implemented Interfaces

GimpPaintOptions implements GimpConfigInterface.

Properties

  "application-mode"         GimpPaintApplicationMode  : Read / Write / Construct
  "brush-angle"              gdouble               : Read / Write / Construct
  "brush-aspect-ratio"       gdouble               : Read / Write / Construct
  "brush-size"               gdouble               : Read / Write / Construct
  "brush-view-size"          gint                  : Read / Write / Construct
  "brush-view-type"          GimpViewType          : Read / Write / Construct
  "dynamics-expanded"        gboolean              : Read / Write / Construct
  "dynamics-view-size"       gint                  : Read / Write / Construct
  "dynamics-view-type"       GimpViewType          : Read / Write / Construct
  "fade-length"              gdouble               : Read / Write / Construct
  "fade-repeat"              GimpRepeatMode        : Read / Write / Construct
  "fade-reverse"             gboolean              : Read / Write / Construct
  "fade-unit"                GimpUnit              : Read / Write / Construct
  "gradient-reverse"         gboolean              : Read / Write / Construct
  "gradient-view-size"       gint                  : Read / Write / Construct
  "gradient-view-type"       GimpViewType          : Read / Write / Construct
  "hard"                     gboolean              : Read / Write / Construct
  "jitter-amount"            gdouble               : Read / Write / Construct
  "paint-info"               GimpPaintInfo*        : Read / Write / Construct Only
  "pattern-view-size"        gint                  : Read / Write / Construct
  "pattern-view-type"        GimpViewType          : Read / Write / Construct
  "smoothing-factor"         gdouble               : Read / Write / Construct
  "smoothing-quality"        gint                  : Read / Write / Construct
  "use-jitter"               gboolean              : Read / Write / Construct
  "use-smoothing"            gboolean              : Read / Write / Construct

Description

Details

GIMP_PAINT_OPTIONS_CONTEXT_MASK

#define             GIMP_PAINT_OPTIONS_CONTEXT_MASK


struct GimpJitterOptions

struct GimpJitterOptions {
  gboolean  use_jitter;
  gdouble   jitter_amount;
};


struct GimpFadeOptions

struct GimpFadeOptions {
  gboolean        fade_reverse;
  gdouble         fade_length;
  GimpUnit        fade_unit;
  GimpRepeatMode  fade_repeat;
};


struct GimpGradientOptions

struct GimpGradientOptions {
  gboolean        gradient_reverse;
  GimpRepeatMode  gradient_repeat;
};


struct GimpSmoothingOptions

struct GimpSmoothingOptions {
  gboolean use_smoothing;
  gint     smoothing_quality;
  gdouble  smoothing_factor;
};


GimpPaintOptions

typedef struct _GimpPaintOptions GimpPaintOptions;


gimp_paint_options_new ()

GimpPaintOptions *  gimp_paint_options_new              (GimpPaintInfo *paint_info);


gimp_paint_options_get_fade ()

gdouble             gimp_paint_options_get_fade         (GimpPaintOptions *paint_options,
                                                         GimpImage *image,
                                                         gdouble pixel_dist);


gimp_paint_options_get_jitter ()

gdouble             gimp_paint_options_get_jitter       (GimpPaintOptions *paint_options,
                                                         GimpImage *image);


gimp_paint_options_get_gradient_color ()

gboolean            gimp_paint_options_get_gradient_color
                                                        (GimpPaintOptions *paint_options,
                                                         GimpImage *image,
                                                         gdouble grad_point,
                                                         gdouble pixel_dist,
                                                         GimpRGB *color);


gimp_paint_options_get_brush_mode ()

GimpBrushApplicationMode gimp_paint_options_get_brush_mode
                                                        (GimpPaintOptions *paint_options);


gimp_paint_options_copy_brush_props ()

void                gimp_paint_options_copy_brush_props (GimpPaintOptions *src,
                                                         GimpPaintOptions *dest);


gimp_paint_options_copy_dynamics_props ()

void                gimp_paint_options_copy_dynamics_props
                                                        (GimpPaintOptions *src,
                                                         GimpPaintOptions *dest);


gimp_paint_options_copy_gradient_props ()

void                gimp_paint_options_copy_gradient_props
                                                        (GimpPaintOptions *src,
                                                         GimpPaintOptions *dest);

Property Details

The "application-mode" property

  "application-mode"         GimpPaintApplicationMode  : Read / Write / Construct

Every stamp has its own opacity.

Default value: GIMP_PAINT_CONSTANT


The "brush-angle" property

  "brush-angle"              gdouble               : Read / Write / Construct

Brush Angle.

Allowed values: [-180,180]

Default value: 0


The "brush-aspect-ratio" property

  "brush-aspect-ratio"       gdouble               : Read / Write / Construct

Brush Aspect Ratio.

Allowed values: [-20,20]

Default value: 0


The "brush-size" property

  "brush-size"               gdouble               : Read / Write / Construct

Brush Size.

Allowed values: [1,10000]

Default value: 20


The "brush-view-size" property

  "brush-view-size"          gint                  : Read / Write / Construct

Allowed values: [12,64]

Default value: 24


The "brush-view-type" property

  "brush-view-type"          GimpViewType          : Read / Write / Construct

Default value: GIMP_VIEW_TYPE_GRID


The "dynamics-expanded" property

  "dynamics-expanded"        gboolean              : Read / Write / Construct

Default value: FALSE


The "dynamics-view-size" property

  "dynamics-view-size"       gint                  : Read / Write / Construct

Allowed values: [12,64]

Default value: 24


The "dynamics-view-type" property

  "dynamics-view-type"       GimpViewType          : Read / Write / Construct

Default value: GIMP_VIEW_TYPE_LIST


The "fade-length" property

  "fade-length"              gdouble               : Read / Write / Construct

Distance over which strokes fade out.

Allowed values: [0,32767]

Default value: 100


The "fade-repeat" property

  "fade-repeat"              GimpRepeatMode        : Read / Write / Construct

How fade is repeated as you paint.

Default value: GIMP_REPEAT_NONE


The "fade-reverse" property

  "fade-reverse"             gboolean              : Read / Write / Construct

Reverse direction of fading.

Default value: FALSE


The "fade-unit" property

  "fade-unit"                GimpUnit              : Read / Write / Construct

Allowed values: [0,65535]

Default value: 0


The "gradient-reverse" property

  "gradient-reverse"         gboolean              : Read / Write / Construct

Default value: FALSE


The "gradient-view-size" property

  "gradient-view-size"       gint                  : Read / Write / Construct

Allowed values: [12,64]

Default value: 48


The "gradient-view-type" property

  "gradient-view-type"       GimpViewType          : Read / Write / Construct

Default value: GIMP_VIEW_TYPE_LIST


The "hard" property

  "hard"                     gboolean              : Read / Write / Construct

Ignore fuzziness of the current brush.

Default value: FALSE


The "jitter-amount" property

  "jitter-amount"            gdouble               : Read / Write / Construct

Distance of scattering.

Allowed values: [0,50]

Default value: 0.2


The "paint-info" property

  "paint-info"               GimpPaintInfo*        : Read / Write / Construct Only


The "pattern-view-size" property

  "pattern-view-size"        gint                  : Read / Write / Construct

Allowed values: [12,64]

Default value: 24


The "pattern-view-type" property

  "pattern-view-type"        GimpViewType          : Read / Write / Construct

Default value: GIMP_VIEW_TYPE_GRID


The "smoothing-factor" property

  "smoothing-factor"         gdouble               : Read / Write / Construct

Gravity of the pen.

Allowed values: [3,1000]

Default value: 50


The "smoothing-quality" property

  "smoothing-quality"        gint                  : Read / Write / Construct

Depth of smoothing.

Allowed values: [1,100]

Default value: 20


The "use-jitter" property

  "use-jitter"               gboolean              : Read / Write / Construct

Scatter brush as you paint.

Default value: FALSE


The "use-smoothing" property

  "use-smoothing"            gboolean              : Read / Write / Construct

Paint smoother strokes.

Default value: FALSE