WSHCommon/Common/Library/SharpFont-master/SharpFont/Cache/Scaler.cs

#region MIT License
/*Copyright (c) 2012 Robert Rouhani <robert.rouhani@gmail.com>

SharpFont based on Tao.FreeType, Copyright (c) 2003-2007 Tao Framework Team

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.*/
#endregion

using System;
using System.Runtime.InteropServices;

using SharpFont.Cache.Internal;

namespace SharpFont.Cache
{
	/// <summary>
	/// A structure used to describe a given character size in either pixels or points to the cache manager.
	/// </summary>
	/// <remarks>
	/// This type is mainly used to retrieve <see cref="FTSize"/> objects through the cache manager.
	/// </remarks>
	/// <see cref="Manager.LookupSize"/>
	public class Scaler
	{
		#region Fields

		private IntPtr reference;
		private ScalerRec rec;

		#endregion

		#region Constructors

		internal Scaler(IntPtr reference)
		{
			Reference = reference;
		}

		#endregion

		#region Properties

		/// <summary>
		/// Gets the source face ID.
		/// </summary>
		public IntPtr FaceId
		{
			get
			{
				return rec.face_id;
			}
		}

		/// <summary>
		/// Gets the character width.
		/// </summary>
		[CLSCompliant(false)]
		public uint Width
		{
			get
			{
				return rec.width;
			}
		}

		/// <summary>
		/// Gets the character height.
		/// </summary>
		[CLSCompliant(false)]
		public uint Height
		{
			get
			{
				return rec.height;
			}
		}

		/// <summary>
		/// Gets a boolean. If true, the ‘width’ and ‘height’ fields are interpreted as integer pixel character sizes.
		/// Otherwise, they are expressed as 1/64th of points.
		/// </summary>
		public bool Pixel
		{
			get
			{
				return rec.pixel == 1;
			}
		}

		/// <summary>
		/// Gets the horizontal resolution in dpi; only used when ‘pixel’ is value 0.
		/// </summary>
		[CLSCompliant(false)]
		public uint ResolutionX
		{
			get
			{
				return rec.x_res;
			}
		}

		/// <summary>
		/// Gets the vertical resolution in dpi; only used when ‘pixel’ is value 0.
		/// </summary>
		[CLSCompliant(false)]
		public uint ResolutionY
		{
			get
			{
				return rec.y_res;
			}
		}

		internal IntPtr Reference
		{
			get
			{
				return reference;
			}

			set
			{
				reference = value;
				rec = PInvokeHelper.PtrToStructure<ScalerRec>(reference);
			}
		}

		#endregion
	}
}