epoc32/include/bitmaptransforms.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000 (2010-03-16)
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// This is the public client API for the BitmapTransforms Library
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
#ifndef __BITMAPTRANSFORMS_H__
williamr@2
    19
#define __BITMAPTRANSFORMS_H__
williamr@2
    20
williamr@2
    21
#include <e32base.h>
williamr@2
    22
#include <fbs.h>
williamr@2
    23
#include <bitdev.h>
williamr@2
    24
williamr@2
    25
class CBitmapRotatorBody;
williamr@2
    26
class CBitmapScalerBody;
williamr@2
    27
class CBitmapConverterBody;
williamr@2
    28
williamr@2
    29
williamr@2
    30
/**
williamr@2
    31
The public API for clients to call the BitmapTransforms Library bitmap rotation.
williamr@2
    32
williamr@2
    33
@publishedAll
williamr@2
    34
@released
williamr@2
    35
*/
williamr@2
    36
williamr@2
    37
//The public API for clients to call the BitmapTransforms Library bitmap rotation
williamr@2
    38
class CBitmapRotator : public CBase
williamr@2
    39
{
williamr@2
    40
public:
williamr@2
    41
williamr@2
    42
	/**
williamr@2
    43
	The enumeration provides a set of supported rotation and mirror angles.
williamr@2
    44
	TRotationAngle is an enumeration within the namespace CBitmapRotator.
williamr@2
    45
	*/
williamr@2
    46
	enum TRotationAngle
williamr@2
    47
		{
williamr@2
    48
		/** Used to rotate a bitmap 90 degrees clockwise.
williamr@2
    49
		*/
williamr@2
    50
		ERotation90DegreesClockwise,
williamr@2
    51
		/** Used to rotate a bitmap 180 degrees clockwise.
williamr@2
    52
		*/
williamr@2
    53
		ERotation180DegreesClockwise,
williamr@2
    54
		/** Used to rotate a bitmap 270 degrees clockwise.
williamr@2
    55
		*/
williamr@2
    56
		ERotation270DegreesClockwise,
williamr@2
    57
		/** Used to mirror a bitmap about the horizontal axis.
williamr@2
    58
		*/
williamr@2
    59
		EMirrorHorizontalAxis,
williamr@2
    60
		/** Used to mirror a bitmap about the vertical axis.
williamr@2
    61
		*/
williamr@2
    62
		EMirrorVerticalAxis
williamr@2
    63
		};
williamr@2
    64
williamr@2
    65
public:
williamr@2
    66
	IMPORT_C static CBitmapRotator* NewL();
williamr@2
    67
	IMPORT_C ~CBitmapRotator();
williamr@2
    68
	IMPORT_C void Rotate(TRequestStatus* aRequestStatus, CFbsBitmap& aSrcBitmap, CFbsBitmap& aTgtBitmap, TRotationAngle aAngle);
williamr@2
    69
	IMPORT_C void Rotate(TRequestStatus* aRequestStatus, CFbsBitmap& aBitmap, TRotationAngle aAngle);
williamr@2
    70
	IMPORT_C TInt CustomCommand(TUid aUid, TAny* aParam);
williamr@2
    71
	IMPORT_C void Cancel();
williamr@2
    72
williamr@2
    73
private:
williamr@2
    74
	CBitmapRotator();
williamr@2
    75
	void ConstructL();
williamr@2
    76
williamr@2
    77
private:
williamr@2
    78
	CBitmapRotatorBody	*iBody;
williamr@2
    79
};
williamr@2
    80
williamr@2
    81
/**
williamr@2
    82
The public API for clients to call the BitmapTransforms Library bitmap scaling.
williamr@2
    83
williamr@2
    84
@publishedAll
williamr@2
    85
@released
williamr@2
    86
*/
williamr@2
    87
williamr@2
    88
//The public API for clients to call the BitmapTransforms library bitmap scaling
williamr@2
    89
class CBitmapScaler : public CBase
williamr@2
    90
{
williamr@2
    91
public:
williamr@2
    92
	/** An enumeration to specify the level of quality algorithm.
williamr@2
    93
	*/
williamr@2
    94
	enum TQualityAlgorithm
williamr@2
    95
		{
williamr@2
    96
		/**
williamr@2
    97
		Fastest/lowest quality
williamr@2
    98
		*/
williamr@2
    99
		EMinimumQuality,
williamr@2
   100
		/**
williamr@2
   101
		Middle range speed/middle range quality
williamr@2
   102
		*/
williamr@2
   103
		EMediumQuality,
williamr@2
   104
		/**
williamr@2
   105
		Slowest/highest quality
williamr@2
   106
		*/
williamr@2
   107
		EMaximumQuality
williamr@2
   108
		};
williamr@2
   109
williamr@2
   110
public:
williamr@2
   111
	IMPORT_C static CBitmapScaler* NewL();
williamr@2
   112
	IMPORT_C ~CBitmapScaler();
williamr@2
   113
	IMPORT_C void Scale(TRequestStatus* aRequestStatus, CFbsBitmap& aSrcBitmap, CFbsBitmap& aTgtBitmap, TBool aMaintainAspectRatio = ETrue);
williamr@2
   114
	IMPORT_C void Scale(TRequestStatus* aRequestStatus, CFbsBitmap& aBitmap, const TSize& aDestinationSize, TBool aMaintainAspectRatio = ETrue);
williamr@2
   115
	IMPORT_C void Cancel();
williamr@2
   116
	IMPORT_C TInt CustomCommand(TUid aUid, TAny* aParam);
williamr@2
   117
    inline TInt DisablePostProcessing( TBool aState );
williamr@2
   118
	inline TInt UseLowMemoryAlgorithm( TBool aState );
williamr@2
   119
	inline TInt SetQualityAlgorithm( TQualityAlgorithm aQualityLevel );
williamr@2
   120
private:
williamr@2
   121
	CBitmapScaler();
williamr@2
   122
	void ConstructL();
williamr@2
   123
williamr@2
   124
private:
williamr@2
   125
	CBitmapScalerBody* iBody;
williamr@2
   126
	};
williamr@2
   127
williamr@2
   128
#include <bitmaptransforms.inl>
williamr@2
   129
williamr@2
   130
#endif //__BITMAPTRANSFORMS_H__