sl@0: // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // Interface for Render Stage Screen Abstraction
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @publishedPartner
sl@0:  @prototype
sl@0: */
sl@0: 
sl@0: #ifndef WSSCREENDEVICE_H
sl@0: #define WSSCREENDEVICE_H
sl@0: 
sl@0: #include <w32std.h>
sl@0: #include <graphics/wsgraphicdrawerinterface.h>
sl@0: 
sl@0: /** Render Stage Palette support.
sl@0: 
sl@0: This interface is intended to be optionally provided by a Render Stage
sl@0: when the pixel target can provide a Colour Palette.  Not all pixel targets have
sl@0: this feature, for example OpenVG only targets.
sl@0: @publishedPartner
sl@0: @prototype
sl@0: */
sl@0: class MWsPalette : public MWsObjectProvider
sl@0: 	{
sl@0: public:
sl@0: 	DECLARE_WS_TYPE_ID(KMWsPalette)
sl@0: 	virtual void PaletteAttributes(TBool& aModifiable,TInt& aNumEntries) const = 0;
sl@0: 	virtual TInt GetPalette(CPalette*& aPalette) const = 0;
sl@0: 	virtual TInt SetCustomPalette(const CPalette* aPalette) = 0;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /** Render Stage Screen Device abstraction.
sl@0: 
sl@0: Render Stages provide this interface as an abstraction of the target screen.
sl@0: The screen may not be pixel based, in which case read back of pixel data may
sl@0: not be a reflection of what appears on the screen.  The screen might also only
sl@0: be partially readable, for example external video surfaces may be blanked out
sl@0: when a read back is done.  The intention of the CopyScreenToBitmap methods is
sl@0: to provide a means to obtain a snapshot of the entire screen for architectures
sl@0: where a composition of the screen can be done once followed by a read back
sl@0: of the entire screen, as opposed to servicing a sequence of GetScanLine calls
sl@0: which may be prohibitively expensive.
sl@0: 
sl@0: @publishedPartner
sl@0: @prototype
sl@0: */
sl@0: class MWsScreenDevice : public MWsObjectProvider
sl@0: 	{
sl@0: public:
sl@0: 	DECLARE_WS_TYPE_ID(KMWsScreenDevice)
sl@0: 
sl@0: 	virtual TInt ScreenNumber() const = 0;
sl@0: 	virtual TDisplayMode DisplayMode() const = 0;
sl@0: 	virtual TSize SizeInPixels() const = 0;
sl@0: 	virtual TSize SizeInTwips() const = 0;
sl@0: 	virtual TRect PointerRect() const = 0;
sl@0: 	virtual void GetPixel(TRgb& aColor,const TPoint& aPixel) const = 0;
sl@0: 	virtual void GetScanLine(TDes8& aScanLine,const TPoint& aStartPixel,TInt aPixelLength, TDisplayMode aDispMode) const = 0;
sl@0: 	virtual TBool RectCompare(const TRect& aRect1, const TRect& aRect2) const = 0;
sl@0: 	virtual void CopyScreenToBitmapL(CFbsBitmap* aBitmap, const TRect& aRect) const = 0;
sl@0: 	virtual void ClearDisplay(TRgb aBackColor)=0;
sl@0: 	};
sl@0: 
sl@0: #endif // WSSCREENDEVICE_H