1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/os/graphics/graphicsresourceservices/graphicsresourceadaptation/inc/sgimage_chunk.h	Fri Jun 15 03:10:57 2012 +0200
     1.3 @@ -0,0 +1,73 @@
     1.4 +// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of "Eclipse Public License v1.0"
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +/**
    1.20 + @file
    1.21 + @internalTechnology
    1.22 + @prototype
    1.23 +*/
    1.24 +
    1.25 +#ifndef SGIMAGE_CHUNK_H
    1.26 +#define SGIMAGE_CHUNK_H
    1.27 +
    1.28 +#include <e32std.h>
    1.29 +
    1.30 +
    1.31 +/**
    1.32 +@internalTechnology
    1.33 +@prototype
    1.34 +
    1.35 +This interface allows access to the data chunk where an image is stored. The chunk
    1.36 +handle obtained through this interface can be passed to device drivers that need
    1.37 +access to the pixel data of the image.
    1.38 +
    1.39 +This interface is only supported if the image is stored in a shared chunk.
    1.40 +*/
    1.41 +class MSgImage_Chunk
    1.42 +	{
    1.43 +public:
    1.44 +	enum { EInterfaceUid = 0x102858F1 };
    1.45 +	/**
    1.46 +	@internalTechnology
    1.47 +	@prototype
    1.48 +
    1.49 +	Retrieves a handle to the chunk where the pixel data is stored. The returned
    1.50 +	chunk handle is valid until the RSgImage handle is closed.
    1.51 +
    1.52 +	@return A handle to the chunk where the pixel data is stored.
    1.53 +	*/
    1.54 +	virtual const RChunk& DataChunk() const = 0;
    1.55 +	/**
    1.56 +	@internalTechnology
    1.57 +	@prototype
    1.58 +
    1.59 +	Retrieves the base offset of the pixel data from the base of the chunk.
    1.60 +
    1.61 +	@return The base offset of the pixel data from the base of the chunk.
    1.62 +	*/
    1.63 +	virtual TInt DataOffset() const = 0;
    1.64 +	/**
    1.65 +	@internalTechnology
    1.66 +	@prototype
    1.67 +
    1.68 +	Retrieves the number of bytes between rows of the pixel data in the chunk.
    1.69 +
    1.70 +	@return The number of bytes between rows of the pixel data in the chunk.
    1.71 +	*/
    1.72 +	virtual TInt DataStride() const = 0;
    1.73 +	};
    1.74 +
    1.75 +
    1.76 +#endif // SGIMAGE_CHUNK_H