sl@0: // Copyright (c) 2007-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: /**
sl@0:  @file
sl@0:  @internalTechnology
sl@0:  @prototype
sl@0: */
sl@0: 
sl@0: #ifndef SGIMAGE_CHUNK_H
sl@0: #define SGIMAGE_CHUNK_H
sl@0: 
sl@0: #include <e32std.h>
sl@0: 
sl@0: 
sl@0: /**
sl@0: @internalTechnology
sl@0: @prototype
sl@0: 
sl@0: This interface allows access to the data chunk where an image is stored. The chunk
sl@0: handle obtained through this interface can be passed to device drivers that need
sl@0: access to the pixel data of the image.
sl@0: 
sl@0: This interface is only supported if the image is stored in a shared chunk.
sl@0: */
sl@0: class MSgImage_Chunk
sl@0: 	{
sl@0: public:
sl@0: 	enum { EInterfaceUid = 0x102858F1 };
sl@0: 	/**
sl@0: 	@internalTechnology
sl@0: 	@prototype
sl@0: 
sl@0: 	Retrieves a handle to the chunk where the pixel data is stored. The returned
sl@0: 	chunk handle is valid until the RSgImage handle is closed.
sl@0: 
sl@0: 	@return A handle to the chunk where the pixel data is stored.
sl@0: 	*/
sl@0: 	virtual const RChunk& DataChunk() const = 0;
sl@0: 	/**
sl@0: 	@internalTechnology
sl@0: 	@prototype
sl@0: 
sl@0: 	Retrieves the base offset of the pixel data from the base of the chunk.
sl@0: 
sl@0: 	@return The base offset of the pixel data from the base of the chunk.
sl@0: 	*/
sl@0: 	virtual TInt DataOffset() const = 0;
sl@0: 	/**
sl@0: 	@internalTechnology
sl@0: 	@prototype
sl@0: 
sl@0: 	Retrieves the number of bytes between rows of the pixel data in the chunk.
sl@0: 
sl@0: 	@return The number of bytes between rows of the pixel data in the chunk.
sl@0: 	*/
sl@0: 	virtual TInt DataStride() const = 0;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: #endif // SGIMAGE_CHUNK_H