am a4eb894a: Merge "clarify Paint flag docs" into klp-dev (8d860332) · Commits · e / os / android_frameworks_base

graphics/java/android/graphics/Paint.java

+102 −12

Original line number	Diff line number	Diff line
		@@ -87,27 +87,113 @@ public class Paint {
		Align.LEFT, Align.CENTER, Align.RIGHT
		};

		/** bit mask for the flag enabling antialiasing */
		/**
		* Paint flag that enables antialiasing when drawing.
		*
		* <p>Enabling this flag will cause all draw operations that support
		* antialiasing to use it.</p>
		*
		* @see #Paint(int)
		* @see #setFlags(int)
		*/
		public static final int ANTI_ALIAS_FLAG = 0x01;
		/** bit mask for the flag enabling bitmap filtering */
		/**
		* Paint flag that enables bilinear sampling on scaled bitmaps.
		*
		* <p>If cleared, scaled bitmaps will be drawn with nearest neighbor
		* sampling, likely resulting in artifacts. This should generally be on
		* when drawing bitmaps, unless performance-bound (rendering to software
		* canvas) or preferring pixelation artifacts to blurriness when scaling
		* significantly.</p>
		*
		* <p>If bitmaps are scaled for device density at creation time (as
		* resource bitmaps often are) the filtering will already have been
		* done.</p>
		*
		* @see #Paint(int)
		* @see #setFlags(int)
		*/
		public static final int FILTER_BITMAP_FLAG = 0x02;
		/** bit mask for the flag enabling dithering */
		/**
		* Paint flag that enables dithering when blitting.
		*
		* <p>Enabling this flag applies a dither to any blit operation where the
		* target's colour space is more constrained than the source.
		*
		* @see #Paint(int)
		* @see #setFlags(int)
		*/
		public static final int DITHER_FLAG = 0x04;
		/** bit mask for the flag enabling underline text */
		/**
		* Paint flag that applies an underline decoration to drawn text.
		*
		* @see #Paint(int)
		* @see #setFlags(int)
		*/
		public static final int UNDERLINE_TEXT_FLAG = 0x08;
		/** bit mask for the flag enabling strike-thru text */
		/**
		* Paint flag that applies a strike-through decoration to drawn text.
		*
		* @see #Paint(int)
		* @see #setFlags(int)
		*/
		public static final int STRIKE_THRU_TEXT_FLAG = 0x10;
		/** bit mask for the flag enabling fake-bold text */
		/**
		* Paint flag that applies a synthetic bolding effect to drawn text.
		*
		* <p>Enabling this flag will cause text draw operations to apply a
		* simulated bold effect when drawing a {@link Typeface} that is not
		* already bold.</p>
		*
		* @see #Paint(int)
		* @see #setFlags(int)
		*/
		public static final int FAKE_BOLD_TEXT_FLAG = 0x20;
		/** bit mask for the flag enabling linear-text (no caching) */
		/**
		* Paint flag that enables smooth linear scaling of text.
		*
		* <p>Enabling this flag does not actually scale text, but rather adjusts
		* text draw operations to deal gracefully with smooth adjustment of scale.
		* When this flag is enabled, font hinting is disabled to prevent shape
		* deformation between scale factors, and glyph caching is disabled due to
		* the large number of glyph images that will be generated.</p>
		*
		* <p>{@link #SUBPIXEL_TEXT_FLAG} should be used in conjunction with this
		* flag to prevent glyph positions from snapping to whole pixel values as
		* scale factor is adjusted.</p>
		*
		* @see #Paint(int)
		* @see #setFlags(int)
		*/
		public static final int LINEAR_TEXT_FLAG = 0x40;
		/** bit mask for the flag enabling subpixel-text */
		/**
		* Paint flag that enables subpixel positioning of text.
		*
		* <p>Enabling this flag causes glyph advances to be computed with subpixel
		* accuracy.</p>
		*
		* <p>This can be used with {@link #LINEAR_TEXT_FLAG} to prevent text from
		* jittering during smooth scale transitions.</p>
		*
		* @see #Paint(int)
		* @see #setFlags(int)
		*/
		public static final int SUBPIXEL_TEXT_FLAG = 0x80;
		/** bit mask for the flag enabling device kerning for text */
		/** Legacy Paint flag, no longer used. */
		public static final int DEV_KERN_TEXT_FLAG = 0x100;
		/** @hide bit mask for the flag enabling subpixel glyph rendering for text */
		public static final int LCD_RENDER_TEXT_FLAG = 0x200;
		/** bit mask for the flag enabling embedded bitmap strikes for text */
		/**
		* Paint flag that enables the use of bitmap fonts when drawing text.
		*
		* <p>Disabling this flag will prevent text draw operations from using
		* embedded bitmap strikes in fonts, causing fonts with both scalable
		* outlines and bitmap strikes to draw only the scalable outlines, and
		* fonts with only bitmap strikes to not draw at all.</p>
		*
		* @see #Paint(int)
		* @see #setFlags(int)
		*/
		public static final int EMBEDDED_BITMAP_TEXT_FLAG = 0x400;
		/** @hide bit mask for the flag forcing freetype's autohinter on for text */
		public static final int AUTO_HINTING_TEXT_FLAG = 0x800;
		@@ -118,12 +204,16 @@ public class Paint {
		static final int DEFAULT_PAINT_FLAGS = DEV_KERN_TEXT_FLAG \| EMBEDDED_BITMAP_TEXT_FLAG;

		/**
		* Option for {@link #setHinting}: disable hinting.
		* Font hinter option that disables font hinting.
		*
		* @see #setHinting(int)
		*/
		public static final int HINTING_OFF = 0x0;

		/**
		* Option for {@link #setHinting}: enable hinting.
		* Font hinter option that enables font hinting.
		*
		* @see #setHinting(int)
		*/
		public static final int HINTING_ON = 0x1;