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