os/graphics/graphicsresourceservices/graphicsresourceadaptation/inc/sgimage_chunk.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
     1 // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 /**
    17  @file
    18  @internalTechnology
    19  @prototype
    20 */
    21 
    22 #ifndef SGIMAGE_CHUNK_H
    23 #define SGIMAGE_CHUNK_H
    24 
    25 #include <e32std.h>
    26 
    27 
    28 /**
    29 @internalTechnology
    30 @prototype
    31 
    32 This interface allows access to the data chunk where an image is stored. The chunk
    33 handle obtained through this interface can be passed to device drivers that need
    34 access to the pixel data of the image.
    35 
    36 This interface is only supported if the image is stored in a shared chunk.
    37 */
    38 class MSgImage_Chunk
    39 	{
    40 public:
    41 	enum { EInterfaceUid = 0x102858F1 };
    42 	/**
    43 	@internalTechnology
    44 	@prototype
    45 
    46 	Retrieves a handle to the chunk where the pixel data is stored. The returned
    47 	chunk handle is valid until the RSgImage handle is closed.
    48 
    49 	@return A handle to the chunk where the pixel data is stored.
    50 	*/
    51 	virtual const RChunk& DataChunk() const = 0;
    52 	/**
    53 	@internalTechnology
    54 	@prototype
    55 
    56 	Retrieves the base offset of the pixel data from the base of the chunk.
    57 
    58 	@return The base offset of the pixel data from the base of the chunk.
    59 	*/
    60 	virtual TInt DataOffset() const = 0;
    61 	/**
    62 	@internalTechnology
    63 	@prototype
    64 
    65 	Retrieves the number of bytes between rows of the pixel data in the chunk.
    66 
    67 	@return The number of bytes between rows of the pixel data in the chunk.
    68 	*/
    69 	virtual TInt DataStride() const = 0;
    70 	};
    71 
    72 
    73 #endif // SGIMAGE_CHUNK_H