offapi/com/sun/star/rendering/RenderState.idl

   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 #ifndef __com_sun_star_rendering_RenderState_idl__
  20 #define __com_sun_star_rendering_RenderState_idl__
  21
  22 #include <com/sun/star/geometry/AffineMatrix2D.idl>
  23 #include <com/sun/star/rendering/XColorSpace.idl>
  24
  25 module com { module sun { module star { module rendering {
  26
  27 interface XPolyPolygon2D;
  28
  29 /** This structure contains information passed to each
  30     XCanvas render operation.<p>
  31
  32     This structure contains information considered as the render
  33     state, i.e. the common setup required to render each individual
  34     XCanvas primitive.<p>
  35
  36     @since OOo 2.0
  37  */
  38 struct RenderState
  39 {
  40     /** The affine transform associated with this render
  41         operation.<p>
  42
  43         This is used to transform coordinates of canvas primitives
  44         from user space to view space (from which they are
  45         subsequently transformed to device space by the view
  46         transform).<p>
  47      */
  48     ::com::sun::star::geometry::AffineMatrix2D  AffineTransform;
  49
  50
  51     /** The clipping area associated with this render operation.<p>
  52
  53         This clipping is interpreted in the user coordinate system,
  54         i.e. subject to the render state transform followed by the
  55         view transform before mapped to device coordinate space.<p>
  56
  57         Specifying an empty interface denotes no clipping,
  58         i.e. everything rendered to the canvas will be visible
  59         (subject to device-dependent constraints, of
  60         course). Specifying an empty XPolyPolygon2D, i.e. a
  61         poly-polygon containing zero polygons, or an XPolyPolygon2D
  62         with any number of empty sub-polygons, denotes the NULL
  63         clip. That means, nothing rendered to the canvas will be
  64         visible.<p>
  65      */
  66     XPolyPolygon2D                                      Clip;
  67
  68
  69     /** The device color associated with this render operation.<p>
  70
  71         Note that this need not be RGB here, but depends on the active
  72         device color space.<p>
  73
  74         @see XGraphicDevice
  75         @see XColorSpace
  76      */
  77     sequence<ColorComponent>                            DeviceColor;
  78
  79
  80     /** The composition mode associated with this render
  81         operation.<p>
  82
  83         The composite mode determines in which way the primitive and
  84         possibly existing background is combined. The permissible
  85         values must be one out of the CompositeOperation
  86         constants.<p>
  87      */
  88     byte                                                CompositeOperation;
  89 };
  90
  91 }; }; }; };
  92
  93 #endif
  94
  95 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */