epoc32/include/graphicsaccelerator.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
     1.1 --- a/epoc32/include/graphicsaccelerator.h	Wed Mar 31 12:27:01 2010 +0100
     1.2 +++ b/epoc32/include/graphicsaccelerator.h	Wed Mar 31 12:33:34 2010 +0100
     1.3 @@ -1,9 +1,9 @@
     1.4  // Copyright (c) 2001-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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.8 +// under the terms of "Eclipse Public License v1.0"
     1.9  // which accompanies this distribution, and is available
    1.10 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
    1.12  //
    1.13  // Initial Contributors:
    1.14  // Nokia Corporation - initial contribution.
    1.15 @@ -42,8 +42,7 @@
    1.16  class TAcceleratedBitmapInfo
    1.17  	{
    1.18  public:
    1.19 -
    1.20 -    /** The bitmap's display mode. */
    1.21 +	/** The display mode of the bitmap. */
    1.22  	TDisplayMode	iDisplayMode;
    1.23  
    1.24  	/** The address of the start of the bitmap. */
    1.25 @@ -52,17 +51,26 @@
    1.26  	/** The width and height of the bitmap in pixels. */
    1.27  	TSize			iSize;
    1.28  	
    1.29 -	/** The address offset (in bytes) between successive lines in a bitmap. */
    1.30 +	/** The address offset (in bytes) between successive lines in a bitmap.
    1.31 +	If the bitmap is compressed the line pitch has no meaning so this data
    1.32 +	member is set to the negation of the compression type. In the case of
    1.33 +	an extended bitmap it is -EProprietaryCompression. */
    1.34  	TInt			iLinePitch;
    1.35  	
    1.36 -	/** The shift required to obtain the number of bits needed to represent one pixel in the bitmap.
    1.37 -	The number of bits per pixel is calculated as 1 << iPixelShift */
    1.38 +	/** The shift required to obtain the number of bits needed to represent one pixel
    1.39 +	in the bitmap. The number of bits per pixel is calculated as 1 << iPixelShift.
    1.40 +	In the case of an extended bitmap this data member is set to the bitmap type UID. */
    1.41  	TInt			iPixelShift;
    1.42  	
    1.43 -	/** The physical address of the start of the bitmap. This is the address which a 
    1.44 -	hardware graphics accelerator will use and is zero if the bitmap is not accessible 
    1.45 -	to hardware graphics accelerators. */
    1.46 -	TUint8*			iPhysicalAddress;
    1.47 +	union
    1.48 +		{
    1.49 +		/** The physical address of the start of the bitmap. This is the address which a
    1.50 +		hardware graphics accelerator will use and is zero if the bitmap is not accessible
    1.51 +		to hardware graphics accelerators. Invalid in the case of an extended bitmap. */
    1.52 +		TUint8*		iPhysicalAddress;
    1.53 +		/** In the case of an extended bitmap, the size of the raw bitmap data. */
    1.54 +		TInt		iDataSize;
    1.55 +		};
    1.56  	};
    1.57  
    1.58  /**
    1.59 @@ -431,24 +439,25 @@
    1.60  	@see CGraphicsContext::TFillRule */
    1.61  		EPolygonFillWinding = 2,
    1.62  		};
    1.63 -		
    1.64 +
    1.65 +	 		
    1.66  /** Bit flags for the specifying the supported rendering orientations. 
    1.67  @see  CFbsBitGc::TGraphicsOrientation */
    1.68 -	enum TOrientationCaps
    1.69 -		{
    1.70 -		/** Normal orientation is supported. */
    1.71 -		EOrientationCapNormal = 1,
    1.72 -		/** A 90 degree rotation is supported. */
    1.73 -		EOrientationCapRotated90 = 2,
    1.74 -		/** A 180 degree rotation is supported. */
    1.75 -		EOrientationCapRotated180 = 4,
    1.76 -		/** A 270 degree rotation is supported. */
    1.77 -		EOrientationCapRotated270 = 8,
    1.78 -		/** All orientations are supported. */ 
    1.79 -		EOrientationCapAll = EOrientationCapNormal|EOrientationCapRotated90|EOrientationCapRotated180|EOrientationCapRotated270,
    1.80 -		};
    1.81 + 	enum TOrientationCaps
    1.82 + 		{
    1.83 + 		/** Normal orientation is supported. */
    1.84 + 		EOrientationCapNormal = 1,
    1.85 + 		/** A 90 degree rotation is supported. */
    1.86 + 		EOrientationCapRotated90 = 2,
    1.87 + 		/** A 180 degree rotation is supported. */
    1.88 + 		EOrientationCapRotated180 = 4,
    1.89 + 		/** A 270 degree rotation is supported. */
    1.90 + 		EOrientationCapRotated270 = 8,
    1.91 + 		/** All orientations are supported. */ 
    1.92 + 		EOrientationCapAll = EOrientationCapNormal|EOrientationCapRotated90|EOrientationCapRotated180|EOrientationCapRotated270
    1.93 + 		};
    1.94  
    1.95 -	/** The size of this class in bytes. */
    1.96 + 	/** The size of this class in bytes. */
    1.97  	TInt			iStructureSize;	// The size of this class
    1.98  	
    1.99  	/** The version number of the API. */
   1.100 @@ -521,13 +530,13 @@
   1.101  	@see TPolygonCaps */
   1.102  	TUint			iPolygon;		// TPolygonCaps bit flags
   1.103  	
   1.104 -	/** 
   1.105 -	iReserved[0] specifies the supported rendering orientations.Uses a bit flags
   1.106 -	for each TOrientationCaps supported.	
   1.107 -	@see TOrientationCaps 
   1.108 -	iReserved[1]-iReserved[3] are reserved for future use. All should be set to zero.
   1.109 -	*/
   1.110 -	TUint			iReserved[4];
   1.111 + 	/** 
   1.112 + 	iReserved[0] specifies the supported rendering orientations.Uses a bit flags
   1.113 + 	for each TOrientationCaps supported.	
   1.114 + 	@see TOrientationCaps 
   1.115 + 	iReserved[1]-iReserved[3] are reserved for future use. All should be set to zero.
   1.116 + 	*/
   1.117 + 	TUint			iReserved[4];
   1.118  	};
   1.119  
   1.120