Merge pull request #1035 from b-editor/opacity-property

Added Opacity property to Drawable class

src/Beutl.Engine/Graphics/CanvasPushedState.cs

@@ -42,6 +42,26 @@ public override void Pop(ImmediateCanvas canvas)
             }
         }
 
+        internal record OpacityPushedState(float Opacity, int Count, SKPaint Paint) : CanvasPushedState
+        {
+            public override void Pop(ImmediateCanvas canvas)
+            {
+                canvas._sharedFillPaint.Reset();
+                canvas._sharedFillPaint.BlendMode = SKBlendMode.DstIn;
+
+                canvas.Canvas.SaveLayer(canvas._sharedFillPaint);
+                using (SKPaint maskPaint = Paint)
+                {
+                    canvas.Canvas.DrawPaint(maskPaint);
+                }
+
+                canvas.Canvas.Restore();
+
+                canvas.Canvas.RestoreToCount(Count);
+                canvas.Opacity = Opacity;
+            }
+        }
+
         public abstract void Pop(ImmediateCanvas canvas);
     }
 }

src/Beutl.Engine/Graphics/Drawable.cs

@@ -1,5 +1,4 @@
 using System.ComponentModel.DataAnnotations;
-
 using Beutl.Animation;
 using Beutl.Graphics.Effects;
 using Beutl.Graphics.Transformation;
@@ -21,6 +20,7 @@ public abstract class Drawable : Renderable
     public static readonly CoreProperty<IBrush?> FillProperty;
     public static readonly CoreProperty<IBrush?> OpacityMaskProperty;
     public static readonly CoreProperty<BlendMode> BlendModeProperty;
+    public static readonly CoreProperty<float> OpacityProperty;
     private ITransform? _transform;
     private FilterEffect? _filterEffect;
     private AlignmentX _alignX = AlignmentX.Center;
@@ -29,6 +29,7 @@ public abstract class Drawable : Renderable
     private IBrush? _fill = null;
     private IBrush? _opacityMask;
     private BlendMode _blendMode = BlendMode.SrcOver;
+    private float _opacity = 100;
 
     static Drawable()
     {
@@ -71,18 +72,24 @@ static Drawable()
             .DefaultValue(BlendMode.SrcOver)
             .Register();
 
+        OpacityProperty = ConfigureProperty<float, Drawable>(nameof(Opacity))
+            .Accessor(o => o.Opacity, (o, v) => o.Opacity = v)
+            .DefaultValue(100)
+            .Register();
+
         AffectsRender<Drawable>(
             TransformProperty, FilterEffectProperty,
             AlignmentXProperty, AlignmentYProperty,
             TransformOriginProperty,
             FillProperty, OpacityMaskProperty,
-            BlendModeProperty);
+            BlendModeProperty, OpacityProperty);
     }
 
     // DrawableBrushで使われる
     public Rect Bounds { get; protected set; }
 
-    [Display(Name = nameof(Strings.ImageFilter), ResourceType = typeof(Strings), GroupName = nameof(Strings.ImageFilter))]
+    [Display(Name = nameof(Strings.ImageFilter), ResourceType = typeof(Strings),
+        GroupName = nameof(Strings.ImageFilter))]
     public FilterEffect? FilterEffect
     {
         get => _filterEffect;
@@ -110,7 +117,8 @@ public AlignmentY AlignmentY
         set => SetAndRaise(AlignmentYProperty, ref _alignY, value);
     }
 
-    [Display(Name = nameof(Strings.TransformOrigin), ResourceType = typeof(Strings), GroupName = nameof(Strings.Transform))]
+    [Display(Name = nameof(Strings.TransformOrigin), ResourceType = typeof(Strings),
+        GroupName = nameof(Strings.Transform))]
     public RelativePoint TransformOrigin
     {
         get => _transformOrigin;
@@ -138,6 +146,14 @@ public BlendMode BlendMode
         set => SetAndRaise(BlendModeProperty, ref _blendMode, value);
     }
 
+    [Display(Name = nameof(Strings.Opacity), ResourceType = typeof(Strings))]
+    [Range(0, 100)]
+    public float Opacity
+    {
+        get => _opacity;
+        set => SetAndRaise(OpacityProperty, ref _opacity, value);
+    }
+
     public virtual void Measure(Size availableSize)
     {
         Size size = MeasureCore(availableSize);
@@ -191,6 +207,7 @@ public virtual void Render(ICanvas canvas)
             Rect transformedBounds = rect.TransformToAABB(transform);
             using (canvas.PushBlendMode(BlendMode))
             using (canvas.PushTransform(transform))
+            using (canvas.PushOpacity(Opacity / 100f))
             using (_filterEffect == null ? new() : canvas.PushFilterEffect(_filterEffect))
             using (OpacityMask == null ? new() : canvas.PushOpacityMask(OpacityMask, new Rect(size)))
             {

src/Beutl.Engine/Graphics/ICanvas.cs

@@ -55,6 +55,8 @@ public interface ICanvas : IDisposable
 
     PushedState PushClip(Geometry geometry, ClipOperation operation = ClipOperation.Intersect);
 
+    PushedState PushOpacity(float opacity);
+
     PushedState PushOpacityMask(IBrush mask, Rect bounds, bool invert = false);
 
     PushedState PushFilterEffect(FilterEffect effect);

src/Beutl.Engine/Graphics/ImmediateCanvas.cs

@@ -45,6 +45,8 @@ public ImmediateCanvas(int width, int height)
 
     public BlendMode BlendMode { get; set; } = BlendMode.SrcOver;
 
+    public float Opacity { get; set; } = 1;
+
     public PixelSize Size { get; }
 
     public Matrix Transform
@@ -484,6 +486,19 @@ public PushedState PushClip(Geometry geometry, ClipOperation operation = ClipOpe
         return new PushedState(this, _states.Count);
     }
 
+    public PushedState PushOpacity(float opacity)
+    {
+        VerifyAccess();
+        float oldOpacity = Opacity;
+        Opacity *= opacity;
+        var paint = new SKPaint();
+
+        int count = Canvas.SaveLayer(paint);
+        paint.Color = new SKColor(0, 0, 0, (byte)(Opacity * 255));
+        _states.Push(new CanvasPushedState.OpacityPushedState(oldOpacity, count, paint));
+        return new PushedState(this, _states.Count);
+    }
+
     public PushedState PushOpacityMask(IBrush mask, Rect bounds, bool invert = false)
     {
         VerifyAccess();

src/Beutl.Engine/Graphics/Rendering/DeferradCanvas.cs

@@ -350,6 +350,22 @@ public PushedState PushClip(Geometry geometry, ClipOperation operation = ClipOpe
         return new(this, _nodes.Count);
     }
 
+    public PushedState PushOpacity(float opacity)
+    {
+        OpacityNode? next = Next<OpacityNode>();
+
+        if (next == null || !next.Equals(opacity))
+        {
+            AddAndPush(new OpacityNode(opacity), next);
+        }
+        else
+        {
+            Push(next);
+        }
+
+        return new(this, _nodes.Count);
+    }
+
     public PushedState PushFilterEffect(FilterEffect effect)
     {
         FilterEffectNode? next = Next<FilterEffectNode>();

src/Beutl.Engine/Graphics/Rendering/OpacityNode.cs

@@ -0,0 +1,19 @@
+namespace Beutl.Graphics.Rendering;
+
+public sealed class OpacityNode(float opacity) : ContainerNode
+{
+    public float Opacity { get; } = opacity;
+
+    public bool Equals(float opacity)
+    {
+        return Opacity == opacity;
+    }
+
+    public override void Render(ImmediateCanvas canvas)
+    {
+        using (canvas.PushOpacity(Opacity))
+        {
+            base.Render(canvas);
+        }
+    }
+}

src/Beutl.Operators/Source/EllipseOperation.cs

@@ -28,4 +28,6 @@ public sealed class EllipseOperator : DrawablePublishOperator<EllipseShape>
     public Setter<FilterEffect?> FilterEffect { get; set; } = new(Drawable.FilterEffectProperty, new FilterEffectGroup());
 
     public Setter<BlendMode> BlendMode { get; set; } = new Setter<BlendMode>(Drawable.BlendModeProperty, Graphics.BlendMode.SrcOver);
+
+    public Setter<float> Opacity { get; set; } = new Setter<float>(Drawable.OpacityProperty, 100);
 }

src/Beutl.Operators/Source/GeometryOperator.cs

@@ -28,4 +28,6 @@ public sealed class GeometryOperator : DrawablePublishOperator<GeometryShape>
     public Setter<FilterEffect?> FilterEffect { get; set; } = new(Drawable.FilterEffectProperty, new FilterEffectGroup());
 
     public Setter<BlendMode> BlendMode { get; set; } = new Setter<BlendMode>(Drawable.BlendModeProperty, Graphics.BlendMode.SrcOver);
+
+    public Setter<float> Opacity { get; set; } = new Setter<float>(Drawable.OpacityProperty, 100);
 }

src/Beutl.Operators/Source/RectOperator.cs

@@ -28,4 +28,6 @@ public sealed class RectOperator : DrawablePublishOperator<RectShape>
     public Setter<FilterEffect?> FilterEffect { get; set; } = new(Drawable.FilterEffectProperty, new FilterEffectGroup());
 
     public Setter<BlendMode> BlendMode { get; set; } = new Setter<BlendMode>(Drawable.BlendModeProperty, Graphics.BlendMode.SrcOver);
+
+    public Setter<float> Opacity { get; set; } = new Setter<float>(Drawable.OpacityProperty, 100);
 }

src/Beutl.Operators/Source/RoundedRectOperator.cs

@@ -30,4 +30,6 @@ public sealed class RoundedRectOperator : DrawablePublishOperator<RoundedRectSha
     public Setter<FilterEffect?> FilterEffect { get; set; } = new(Drawable.FilterEffectProperty, new FilterEffectGroup());
 
     public Setter<BlendMode> BlendMode { get; set; } = new Setter<BlendMode>(Drawable.BlendModeProperty, Graphics.BlendMode.SrcOver);
+
+    public Setter<float> Opacity { get; set; } = new Setter<float>(Drawable.OpacityProperty, 100);
 }

src/Beutl.Operators/Source/SourceBackdropOperator.cs

@@ -21,4 +21,6 @@ public sealed class SourceBackdropOperator : DrawablePublishOperator<SourceBackd
     public Setter<FilterEffect?> FilterEffect { get; set; } = new(Drawable.FilterEffectProperty, new FilterEffectGroup());
 
     public Setter<BlendMode> BlendMode { get; set; } = new Setter<BlendMode>(Drawable.BlendModeProperty, Graphics.BlendMode.SrcOver);
+
+    public Setter<float> Opacity { get; set; } = new Setter<float>(Drawable.OpacityProperty, 100);
 }

src/Beutl.Operators/Source/SourceImageOperator.cs

@@ -21,12 +21,12 @@ public sealed class SourceImageOperator : DrawablePublishOperator<SourceImage>
 
     public Setter<RelativePoint> TransformOrigin { get; set; } = new(Drawable.TransformOriginProperty, RelativePoint.Center);
 
-    public Setter<IBrush?> Fill { get; set; } = new(Drawable.FillProperty, new SolidColorBrush(Colors.White));
-
     public Setter<FilterEffect?> FilterEffect { get; set; } = new(Drawable.FilterEffectProperty, new FilterEffectGroup());
 
     public Setter<BlendMode> BlendMode { get; set; } = new Setter<BlendMode>(Drawable.BlendModeProperty, Graphics.BlendMode.SrcOver);
 
+    public Setter<float> Opacity { get; set; } = new Setter<float>(Drawable.OpacityProperty, 100);
+
     protected override void OnDetachedFromHierarchy(in HierarchyAttachmentEventArgs args)
     {
         base.OnDetachedFromHierarchy(args);

src/Beutl.Operators/Source/SourceVideoOperator.cs

@@ -27,12 +27,12 @@ public sealed class SourceVideoOperator : DrawablePublishOperator<SourceVideo>
 
     public Setter<RelativePoint> TransformOrigin { get; set; } = new(Drawable.TransformOriginProperty, RelativePoint.Center);
 
-    public Setter<IBrush?> Fill { get; set; } = new(Drawable.FillProperty, new SolidColorBrush(Colors.White));
-
     public Setter<FilterEffect?> FilterEffect { get; set; } = new(Drawable.FilterEffectProperty, new FilterEffectGroup());
 
     public Setter<BlendMode> BlendMode { get; set; } = new Setter<BlendMode>(Drawable.BlendModeProperty, Graphics.BlendMode.SrcOver);
 
+    public Setter<float> Opacity { get; set; } = new Setter<float>(Drawable.OpacityProperty, 100);
+
     protected override void OnDetachedFromHierarchy(in HierarchyAttachmentEventArgs args)
     {
         base.OnDetachedFromHierarchy(args);

src/Beutl.Operators/Source/TextBlockOperator.cs

@@ -18,7 +18,7 @@ public sealed class TextBlockOperator : DrawablePublishOperator<TextBlock>
     public Setter<FontWeight> FontWeight { get; set; } = new Setter<FontWeight>(TextBlock.FontWeightProperty, Media.FontWeight.Regular);
 
     public Setter<float> Spacing { get; set; } = new Setter<float>(TextBlock.SpacingProperty, 0);
-    
+
     public Setter<bool> SplitByCharacters { get; set; } = new Setter<bool>(TextBlock.SplitByCharactersProperty);
 
     public Setter<string?> Text { get; set; } = new Setter<string?>(TextBlock.TextProperty, string.Empty);
@@ -38,4 +38,6 @@ public sealed class TextBlockOperator : DrawablePublishOperator<TextBlock>
     public Setter<FilterEffect?> FilterEffect { get; set; } = new(Drawable.FilterEffectProperty, new FilterEffectGroup());
 
     public Setter<BlendMode> BlendMode { get; set; } = new Setter<BlendMode>(Drawable.BlendModeProperty, Graphics.BlendMode.SrcOver);
+
+    public Setter<float> Opacity { get; set; } = new Setter<float>(Drawable.OpacityProperty, 100);
 }