1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef _VCLCANVAS_CANVASBITMAPHELPER_HXX_ 25*b1cdbd2cSJim Jagielski #define _VCLCANVAS_CANVASBITMAPHELPER_HXX_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <canvashelper.hxx> 28*b1cdbd2cSJim Jagielski #include <canvas/vclwrapper.hxx> 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski #include <vcl/bitmapex.hxx> 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski #include "bitmapbackbuffer.hxx" 33*b1cdbd2cSJim Jagielski #include "spritecanvas.hxx" 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski namespace vclcanvas 37*b1cdbd2cSJim Jagielski { 38*b1cdbd2cSJim Jagielski /** Helper class for basic canvasbitmap functionality. Extends 39*b1cdbd2cSJim Jagielski CanvasHelper with some CanvasBitmap specialities, such as alpha 40*b1cdbd2cSJim Jagielski support. 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski Note that a plain CanvasHelper, although it does support the 43*b1cdbd2cSJim Jagielski XBitmap interface, has no provision for alpha channel on VCL 44*b1cdbd2cSJim Jagielski (at least no efficient one. If the alpha VDev one day gets 45*b1cdbd2cSJim Jagielski part of SAL, we might change that). 46*b1cdbd2cSJim Jagielski */ 47*b1cdbd2cSJim Jagielski class CanvasBitmapHelper : public CanvasHelper 48*b1cdbd2cSJim Jagielski { 49*b1cdbd2cSJim Jagielski public: 50*b1cdbd2cSJim Jagielski CanvasBitmapHelper(); 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** Set a new bitmap on this helper. 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski This method late-initializes the bitmap canvas helper, 55*b1cdbd2cSJim Jagielski providing it with the necessary device and output 56*b1cdbd2cSJim Jagielski objects. The internally stored bitmap representation is 57*b1cdbd2cSJim Jagielski updated from the given bitmap, including any size 58*b1cdbd2cSJim Jagielski changes. Note that the CanvasHelper does <em>not</em> take 59*b1cdbd2cSJim Jagielski ownership of the SpriteCanvas object, nor does it perform 60*b1cdbd2cSJim Jagielski any reference counting. Thus, to prevent reference counted 61*b1cdbd2cSJim Jagielski objects from deletion, the user of this class is 62*b1cdbd2cSJim Jagielski responsible for holding ref-counted references to those 63*b1cdbd2cSJim Jagielski objects! 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski @param rBitmap 66*b1cdbd2cSJim Jagielski Content of this bitmap is used as our new content (our 67*b1cdbd2cSJim Jagielski internal size is adapted to the size of the bitmap given) 68*b1cdbd2cSJim Jagielski 69*b1cdbd2cSJim Jagielski @param rDevice 70*b1cdbd2cSJim Jagielski Reference device for this canvas bitmap 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski @param rOutDevProvider 73*b1cdbd2cSJim Jagielski Reference output device. Used to create matching bitmap. 74*b1cdbd2cSJim Jagielski */ 75*b1cdbd2cSJim Jagielski void init( const BitmapEx& rBitmap, 76*b1cdbd2cSJim Jagielski ::com::sun::star::rendering::XGraphicDevice& rDevice, 77*b1cdbd2cSJim Jagielski const OutDevProviderSharedPtr& rOutDevProvider ); 78*b1cdbd2cSJim Jagielski 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski // Overridden CanvasHelper functionality 81*b1cdbd2cSJim Jagielski // ===================================== 82*b1cdbd2cSJim Jagielski 83*b1cdbd2cSJim Jagielski void disposing(); 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski void clear(); 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski ::com::sun::star::geometry::IntegerSize2D getSize(); 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XBitmapCanvas > queryBitmapCanvas(); 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::rendering::XBitmap > 92*b1cdbd2cSJim Jagielski getScaledBitmap( const ::com::sun::star::geometry::RealSize2D& newSize, 93*b1cdbd2cSJim Jagielski sal_Bool beFast ); 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Sequence< sal_Int8 > 96*b1cdbd2cSJim Jagielski getData( ::com::sun::star::rendering::IntegerBitmapLayout& bitmapLayout, 97*b1cdbd2cSJim Jagielski const ::com::sun::star::geometry::IntegerRectangle2D& rect ); 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski void setData( const ::com::sun::star::uno::Sequence< sal_Int8 >& data, 100*b1cdbd2cSJim Jagielski const ::com::sun::star::rendering::IntegerBitmapLayout& bitmapLayout, 101*b1cdbd2cSJim Jagielski const ::com::sun::star::geometry::IntegerRectangle2D& rect ); 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski void setPixel( const ::com::sun::star::uno::Sequence< sal_Int8 >& color, 104*b1cdbd2cSJim Jagielski const ::com::sun::star::rendering::IntegerBitmapLayout& bitmapLayout, 105*b1cdbd2cSJim Jagielski const ::com::sun::star::geometry::IntegerPoint2D& pos ); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Sequence< sal_Int8 > 108*b1cdbd2cSJim Jagielski getPixel( ::com::sun::star::rendering::IntegerBitmapLayout& bitmapLayout, 109*b1cdbd2cSJim Jagielski const ::com::sun::star::geometry::IntegerPoint2D& pos ); 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski ::com::sun::star::rendering::IntegerBitmapLayout getMemoryLayout(); 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski /// @internal 114*b1cdbd2cSJim Jagielski BitmapEx getBitmap() const; 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski private: 117*b1cdbd2cSJim Jagielski 118*b1cdbd2cSJim Jagielski void setBitmap( const BitmapEx& rBitmap ); 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski BitmapBackBufferSharedPtr mpBackBuffer; 121*b1cdbd2cSJim Jagielski OutDevProviderSharedPtr mpOutDevReference; 122*b1cdbd2cSJim Jagielski }; 123*b1cdbd2cSJim Jagielski } 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski #endif /* _VCLCANVAS_CANVASBITMAPHELPER_HXX_ */ 126