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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: RenderState.idl,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_rendering_RenderState_idl__
  31 #define __com_sun_star_rendering_RenderState_idl__
  32
  33 #ifndef __com_sun_star_geometry_AffineMatrix2D_idl__
  34 #include <com/sun/star/geometry/AffineMatrix2D.idl>
  35 #endif
  36 #ifndef __com_sun_star_rendering_XColorSpace_idl__
  37 #include <com/sun/star/rendering/XColorSpace.idl>
  38 #endif
  39
  40 module com { module sun { module star { module rendering {
  41
  42 interface XPolyPolygon2D;
  43
  44 /** This structure contains information passed to each
  45     <type>XCanvas</type> render operation.<p>
  46
  47     This structure contains information considered as the render
  48     state, i.e. the common setup required to render each individual
  49     <type>XCanvas</type> primitive.<p>
  50
  51     @since OOo 2.0.0
  52  */
  53 struct RenderState
  54 {
  55     /** The affine transform associated with this render
  56         operation.<p>
  57
  58         This is used to transform coordinates of canvas primitives
  59         from user space to view space (from which they are
  60         subsequently transformed to device space by the view
  61         transform).<p>
  62      */
  63     ::com::sun::star::geometry::AffineMatrix2D  AffineTransform;
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** The clipping area associated with this render operation.<p>
  68
  69         This clipping is interpreted in the user coordinate system,
  70         i.e. subject to the render state transform followed by the
  71         view transform before mapped to device coordinate space.<p>
  72
  73         Specifying an empty interface denotes no clipping,
  74         i.e. everything rendered to the canvas will be visible
  75         (subject to device-dependent constraints, of
  76         course). Specifying an empty XPolyPolygon2D, i.e. a
  77         poly-polygon containing zero polygons, or an XPolyPolygon2D
  78         with any number of empty sub-polygons, denotes the NULL
  79         clip. That means, nothing rendered to the canvas will be
  80         visible.<p>
  81      */
  82     XPolyPolygon2D                                                                              Clip;
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** The device color associated with this render operation.<p>
  87
  88         Note that this need not be RGB here, but depends on the active
  89         device color space.<p>
  90
  91         @see XGraphicDevice
  92         @see XColorSpace
  93      */
  94     sequence<ColorComponent>                                                    DeviceColor;
  95
  96     //-------------------------------------------------------------------------
  97
  98     /** The composition mode associated with this render
  99         operation.<p>
 100
 101         The composite mode determines in which way the primitive and
 102         possibly existing background is combined. The permissible
 103         values must be one out of the <type>CompositeOperation</type>
 104         constants.<p>
 105      */
 106     byte                                                                                                CompositeOperation;
 107 };
 108
 109 }; }; }; };
 110
 111 #endif