IDVPlatformOffscreen.h

//========================================================================================
// 
// $File$
// 
// Owner: Deepak Gupta
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// Core interface around Platform offscreen drawing environments
// 
//========================================================================================

#ifndef __IDVPlatformOffscreen__
#define __IDVPlatformOffscreen__

#include "GRRefCountedObj.h"
#include "InterfacePtr.h"

#ifdef WASM
#include "WasmDrawbot.h"
#else
#include "DVAForwardDeclarations.h"
#endif

#ifndef WASM
typedef boost::intrusive_ptr<dvaui::drawbot::ImageInterface> ImageInterfaceP;
#endif

class IDVPlatformOffscreen : public grRefCountedObj
{ 
public: 
 virtual dvaui::drawbot::Drawbot* GetOffscreenDrawbot() const = 0; 

 virtual void GetOrigin(int32* x, int32* y) const = 0; 

 virtual void SetOrigin(int32 x, int32 y) = 0; 


// virtual void CopyBitsIntoOffscreen(const dvaui::drawbot::Drawbot* srcDrawbot, const Int32Rect &srcBounds, const Int32Rect &dstBounds, const SysRgn clipRgn = nil) = 0; 

 virtual void CopyBitsFromOffscreen(dvaui::drawbot::Drawbot* dstDrawbot, const Int32Rect &srcBounds, const Int32Rect &dstBounds, const PMMatrix& clip2destMatrix = PMMatrix(), const SysRgn clipRgn = nil,
 int debug_cookie = 0, const char* debug_string = 0, void* debug_address = 0 //Ichabod temporary debugging code
 ) = 0; 


// virtual void CopyBitsIntoOffscreen(IDVPlatformOffscreen* srcDVPlatformOffscreen, const Int32Rect &srcBounds, const Int32Rect &dstBounds, const SysRgn clipRgn = nil) = 0; 

 virtual void CopyBitsFromOffscreen(IDVPlatformOffscreen* dstDVPlatformOffscreen, const Int32Rect &srcBounds, const Int32Rect &dstBounds, const PMMatrix& clip2destMatrix = PMMatrix(), const SysRgn clipRgn = nil,
 int debug_cookie = 0, const char* debug_string = 0, void* debug_address = 0 //Ichabod temporary debugging code
 ) = 0; 


 virtual const Int32Rect& GetBounds() = 0; 

 virtual void GetPlatformBitmapInfo(void** baseAddr, uint32* rowBytes, Int32Rect* portRect, uint32* bitsPerPixel = nil) = 0;

 virtual int32 OffscreenError() = 0; 

 virtual bool16 UpdateBitmap(const Int32Rect& bounds, PMReal uiScaleFactor = 1.0) = 0; 

 virtual bool16 UpdateBitmapIfDifferent(const Int32Rect& bounds, PMReal uiScaleFactor = 1.0) = 0; 

 virtual PMReal GetCurrentUIScaleFactorReal() = 0; 

 virtual void CopyBitsFromOffscreen(dvaui::drawbot::Drawbot* dstDrawbot, const Int32Rect &srcBounds, const PMRect &dstBounds, 
 const PMMatrix& clip2destMatrix, const dvaui::drawbot::PathP path,
 int debug_cookie = 0, const char* debug_string = 0, void* debug_address = 0 //Ichabod temporary debugging code
 ) = 0; 
};


template <>
class InterfacePtr<IDVPlatformOffscreen>
{
public:
 InterfacePtr(IDVPlatformOffscreen * pFace)
 : fFace(pFace) {}
 
 ~InterfacePtr()
 {
 if (fFace != nil){
 //const_cast<IDVPlatformOffscreen *>(unknown)->Release();
 fFace->Release();
 }
 }
 
 operator IDVPlatformOffscreen*() const
 { return fFace; }
 // We allow the cast operator to return a nil pointer
 // since it is valid to test against nil and may be valid
 // to pass a nil pointer to some methods.

 
 IDVPlatformOffscreen * operator ->() const
 {
 #ifdef DEBUG
 ASSERT_MSG(fFace != nil,"About to use nil interface ptr!");
 #endif
 return fFace;
 }

private:
 IDVPlatformOffscreen * fFace;

 // If you feel you need one of these, let me know. Thx. - Zak
 // For the sake of clarity and simplicity, they're currently not supported.

 InterfacePtr(void);
 InterfacePtr(const InterfacePtr<IDVPlatformOffscreen>& IDVPlatformOffscreenPtr);
 InterfacePtr<IDVPlatformOffscreen>& operator=(const InterfacePtr<IDVPlatformOffscreen>& IDVPlatformOffscreenPtr);
 InterfacePtr<IDVPlatformOffscreen>& operator=(IDVPlatformOffscreen * pFace);

};

#endif