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: //
sl@0: 
sl@0: #ifndef __WSUIBUFFER_H__
sl@0: #define __WSUIBUFFER_H__
sl@0: 
sl@0: #include <pixelformats.h>
sl@0: #include <graphics/wsgraphicdrawerinterface.h>
sl@0: 
sl@0: /**
sl@0: @file
sl@0: @publishedPartner
sl@0: @prototype 
sl@0: */
sl@0: 
sl@0: /**
sl@0: This class provides direct access to the memory of the UI buffer.
sl@0: 
sl@0: This interface is to be used by CRPs that don't want to go through MWsGraphicsContext
sl@0: to handle their rendering, but want direct memory access.
sl@0: @publishedPartner
sl@0: @prototype
sl@0: */
sl@0: class MWsUiBuffer: public MWsObjectProvider
sl@0:     {
sl@0: public:
sl@0:     DECLARE_WS_TYPE_ID(KMWsUiBufferInterfaceId)
sl@0: 
sl@0:     /**
sl@0:     Finishes pending rendering to the buffer and temporarily makes the pixel 
sl@0:     data of the buffer image accessible for reading and writing by the CPU.
sl@0:     
sl@0:     When finished with the pixel data, the caller must end the mapping by
sl@0:     calling @c Unmap().
sl@0: 
sl@0:     This method should only be called from the context of 
sl@0:     @c CWsGraphicDrawer::Draw().
sl@0:     @param aDataAddress On return, the base address of the pixel data in the
sl@0:     address space of the calling process
sl@0:     @param aDataStride On return, the number of bytes between rows of the
sl@0:     pixel data
sl@0:     @return KErrNone if successful, otherwise one of the standard Symbian
sl@0:     error codes
sl@0:     @see Unmap()
sl@0:     @publishedPartner
sl@0:     @prototype
sl@0:     */
sl@0:     virtual TInt MapReadWrite(TAny*& aDataAddress, TInt& aDataStride) = 0;
sl@0:     
sl@0:     /**
sl@0:     Finishes pending rendering to the buffer and temporarily makes the pixel 
sl@0:     data of the buffer image accessible for writing by the CPU.
sl@0:     
sl@0:     When finished with the pixel data, the caller must end the mapping by
sl@0:     calling @c Unmap().
sl@0: 
sl@0:     This method should only be called from the context of 
sl@0:     @c CWsGraphicDrawer::Draw().
sl@0:     @param aDataAddress On return, the base address of the pixel data in the
sl@0:     address space of the calling process
sl@0:     @param aDataStride On return, the number of bytes between rows of the
sl@0:     pixel data
sl@0:     @return KErrNone if successful, otherwise one of the standard Symbian
sl@0:     error codes
sl@0:     @see Unmap()
sl@0:     @publishedPartner
sl@0:     @prototype
sl@0:     */
sl@0:     virtual TInt MapWriteOnly(TAny*& aDataAddress, TInt& aDataStride) = 0;
sl@0:         
sl@0:     /**
sl@0:     Makes the pixel data of an image no longer accessible to the CPU.
sl@0: 
sl@0:     Before calling this method the buffer must be mapped for CPU access by
sl@0:     a previous call to @c MapReadWrite() or @c MapWriteOnly().
sl@0: 
sl@0:     This method should only be called from the context of 
sl@0:     @c CWsGraphicDrawer::Draw().
sl@0:     @return KErrNone if successful, otherwise one of the standard Symbian
sl@0:     error codes
sl@0:     @see MapReadWrite()
sl@0:     @see MapWriteOnly()
sl@0:     @publishedPartner
sl@0:     @prototype
sl@0:     */
sl@0:     virtual TInt Unmap() = 0;
sl@0: 
sl@0:     /**
sl@0:     Gets the pixel format of the buffer.
sl@0:     @return The pixel format of the buffer
sl@0:     @publishedPartner
sl@0:     @prototype
sl@0:     */
sl@0:     virtual TUidPixelFormat PixelFormat() const = 0;
sl@0: 
sl@0:     /** 
sl@0:     Gets the current size of the buffer.
sl@0: 
sl@0:     The actual size of the whole buffer might be larger than the returned
sl@0:     value depending on the current screen mode. However, it is the size
sl@0:     returned by this method that should be used when accessing the pixel data.
sl@0:     @return The current size of the buffer
sl@0:     @publishedPartner
sl@0:     @prototype
sl@0:     */
sl@0:     virtual TSize SizeInPixels() const = 0;
sl@0:     };
sl@0: 
sl@0: #endif //__WSUiBUFFER_H__