cppcanvas/source/mtfrenderer/transparencygroupaction.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <cppcanvas/canvas.hxx>
  23 #include <vcl/gradient.hxx>
  24 #include <action.hxx>
  25
  26 #include <memory>
  27
  28 namespace basegfx {
  29     class B2DPoint;
  30     class B2DVector;
  31 }
  32
  33 class GDIMetaFile;
  34
  35
  36 /* Definition of internal::TransparencyGroupActionFactory */
  37
  38 namespace cppcanvas::internal
  39     {
  40         struct OutDevState;
  41
  42         /** Transparency group action.
  43
  44             This action groups a bunch of other actions, to be
  45             rendered with the given transparency setting against the
  46             background.
  47
  48             Creates encapsulated converters between GDIMetaFile and
  49             XCanvas. The Canvas argument is deliberately placed at the
  50             constructor, to force reconstruction of this object for a
  51             new canvas. This considerably eases internal state
  52             handling, since a lot of the internal state (e.g. fonts,
  53             text layout) is Canvas-dependent.
  54          */
  55         namespace TransparencyGroupActionFactory
  56         {
  57             /** Create new transparency group action.
  58
  59                 @param rGroupMtf
  60                 Metafile that groups all actions to be rendered
  61                 transparent.
  62
  63                 @param rAlphaGradient
  64                 VCL gradient, to be rendered into the action's alpha
  65                 channel.
  66
  67                 @param rDstPoint
  68                 Left, top edge of destination, in current state
  69                 coordinate system
  70
  71                 @param rDstSize
  72                 Size of the transparency group object, in current
  73                 state coordinate system.
  74              */
  75             std::shared_ptr<Action> createTransparencyGroupAction( std::unique_ptr< GDIMetaFile >&& rGroupMtf,
  76                                                                   std::optional< Gradient >&&   rAlphaGradient,
  77                                                                   const ::basegfx::B2DPoint&    rDstPoint,
  78                                                                   const ::basegfx::B2DVector&   rDstSize,
  79                                                                   const CanvasSharedPtr&        rCanvas,
  80                                                                   const OutDevState&            rState );
  81         }
  82
  83 }
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */