Graphics Class Reference

A graphics context, used for drawing a component or image. More...

List of all members.

Classes
struct	GraphicsState
Public Types
enum	ResamplingQuality { lowResamplingQuality = 0, mediumResamplingQuality = 1, highResamplingQuality = 2 }
	Types of rendering quality that can be specified when drawing images. More...
Public Member Functions
	Graphics (Image &imageToDrawOnto) throw ()
	Creates a Graphics object to draw directly onto the given image.
	~Graphics () throw ()
	Destructor.
void	setColour (const Colour &newColour) throw ()
	Changes the current drawing colour.
void	setOpacity (const float newOpacity) throw ()
	Changes the opacity to use with the current colour.
void	setBrush (const Brush *const newBrush) throw ()
	Changes the current brush to use for drawing.
void	setGradientFill (const ColourGradient &gradient) throw ()
	Sets the context to use a gradient for its fill pattern.
void	setTiledImageFill (Image &imageToUse, const int anchorX, const int anchorY, const float opacity) throw ()
	Sets the context to use a tiled image pattern for filling.
void	setFont (const Font &newFont) throw ()
	Changes the font to use for subsequent text-drawing functions.
void	setFont (const float newFontHeight, const int fontStyleFlags=Font::plain) throw ()
	Changes the size and style of the currently-selected font.
void	drawSingleLineText (const String &text, const int startX, const int baselineY) const throw ()
	Draws a one-line text string.
void	drawMultiLineText (const String &text, const int startX, const int baselineY, const int maximumLineWidth) const throw ()
	Draws text across multiple lines.
void	drawTextAsPath (const String &text, const AffineTransform &transform) const throw ()
	Renders a string of text as a vector path.
void	drawText (const String &text, const int x, const int y, const int width, const int height, const Justification &justificationType, const bool useEllipsesIfTooBig) const throw ()
	Draws a line of text within a specified rectangle.
void	drawFittedText (const String &text, const int x, const int y, const int width, const int height, const Justification &justificationFlags, const int maximumNumberOfLines, const float minimumHorizontalScale=0.7f) const throw ()
	Tries to draw a text string inside a given space.
void	fillAll () const throw ()
	Fills the context's entire clip region with the current colour or brush.
void	fillAll (const Colour &colourToUse) const throw ()
	Fills the context's entire clip region with a given colour.
void	fillRect (int x, int y, int width, int height) const throw ()
	Fills a rectangle with the current colour or brush.
void	fillRect (const Rectangle &rectangle) const throw ()
	Fills a rectangle with the current colour or brush.
void	fillRect (const float x, const float y, const float width, const float height) const throw ()
	Fills a rectangle with the current colour or brush.
void	fillRoundedRectangle (const float x, const float y, const float width, const float height, const float cornerSize) const throw ()
	Uses the current colour or brush to fill a rectangle with rounded corners.
void	fillRoundedRectangle (const Rectangle &rectangle, const float cornerSize) const throw ()
	Uses the current colour or brush to fill a rectangle with rounded corners.
void	fillCheckerBoard (int x, int y, int width, int height, const int checkWidth, const int checkHeight, const Colour &colour1, const Colour &colour2) const throw ()
	Fills a rectangle with a checkerboard pattern, alternating between two colours.
void	drawRect (const int x, const int y, const int width, const int height, const int lineThickness=1) const throw ()
	Draws four lines to form a rectangular outline, using the current colour or brush.
void	drawRect (const float x, const float y, const float width, const float height, const float lineThickness=1.0f) const throw ()
	Draws four lines to form a rectangular outline, using the current colour or brush.
void	drawRect (const Rectangle &rectangle, const int lineThickness=1) const throw ()
	Draws four lines to form a rectangular outline, using the current colour or brush.
void	drawRoundedRectangle (const float x, const float y, const float width, const float height, const float cornerSize, const float lineThickness) const throw ()
	Uses the current colour or brush to draw the outline of a rectangle with rounded corners.
void	drawRoundedRectangle (const Rectangle &rectangle, const float cornerSize, const float lineThickness) const throw ()
	Uses the current colour or brush to draw the outline of a rectangle with rounded corners.
void	drawBevel (const int x, const int y, const int width, const int height, const int bevelThickness, const Colour &topLeftColour=Colours::white, const Colour &bottomRightColour=Colours::black, const bool useGradient=true, const bool sharpEdgeOnOutside=true) const throw ()
	Draws a 3D raised (or indented) bevel using two colours.
void	setPixel (int x, int y) const throw ()
	Draws a pixel using the current colour or brush.
void	fillEllipse (const float x, const float y, const float width, const float height) const throw ()
	Fills an ellipse with the current colour or brush.
void	drawEllipse (const float x, const float y, const float width, const float height, const float lineThickness) const throw ()
	Draws an elliptical stroke using the current colour or brush.
void	drawLine (float startX, float startY, float endX, float endY) const throw ()
	Draws a line between two points.
void	drawLine (const float startX, const float startY, const float endX, const float endY, const float lineThickness) const throw ()
	Draws a line between two points with a given thickness.
void	drawLine (const Line &line) const throw ()
	Draws a line between two points.
void	drawLine (const Line &line, const float lineThickness) const throw ()
	Draws a line between two points with a given thickness.
void	drawDashedLine (const float startX, const float startY, const float endX, const float endY, const float *const dashLengths, const int numDashLengths, const float lineThickness=1.0f) const throw ()
	Draws a dashed line using a custom set of dash-lengths.
void	drawVerticalLine (const int x, float top, float bottom) const throw ()
	Draws a vertical line of pixels at a given x position.
void	drawHorizontalLine (const int y, float left, float right) const throw ()
	Draws a horizontal line of pixels at a given y position.
void	fillPath (const Path &path, const AffineTransform &transform=AffineTransform::identity) const throw ()
	Fills a path using the currently selected colour or brush.
void	strokePath (const Path &path, const PathStrokeType &strokeType, const AffineTransform &transform=AffineTransform::identity) const throw ()
	Draws a path's outline using the currently selected colour or brush.
void	drawArrow (const float startX, const float startY, const float endX, const float endY, const float lineThickness, const float arrowheadWidth, const float arrowheadLength) const throw ()
	Draws a line with an arrowhead.
void	setImageResamplingQuality (const ResamplingQuality newQuality) throw ()
	Changes the quality that will be used when resampling images.
void	drawImageAt (const Image *const imageToDraw, const int topLeftX, const int topLeftY, const bool fillAlphaChannelWithCurrentBrush=false) const throw ()
	Draws an image.
void	drawImage (const Image *const imageToDraw, int destX, int destY, int destWidth, int destHeight, int sourceX, int sourceY, int sourceWidth, int sourceHeight, const bool fillAlphaChannelWithCurrentBrush=false) const throw ()
	Draws part of an image, rescaling it to fit in a given target region.
void	drawImageTransformed (const Image *const imageToDraw, int sourceClipX, int sourceClipY, int sourceClipWidth, int sourceClipHeight, const AffineTransform &transform, const bool fillAlphaChannelWithCurrentBrush=false) const throw ()
	Draws part of an image, having applied an affine transform to it.
void	drawImageWithin (const Image *const imageToDraw, const int destX, const int destY, const int destWidth, const int destHeight, const RectanglePlacement &placementWithinTarget, const bool fillAlphaChannelWithCurrentBrush=false) const throw ()
	Draws an image to fit within a designated rectangle.
const Rectangle	getClipBounds () const throw ()
	Returns the position of the bounding box for the current clipping region.
bool	clipRegionIntersects (const int x, const int y, const int width, const int height) const throw ()
	Checks whether a rectangle overlaps the context's clipping region.
bool	reduceClipRegion (const int x, const int y, const int width, const int height) throw ()
	Intersects the current clipping region with another region.
bool	reduceClipRegion (const RectangleList &clipRegion) throw ()
	Intersects the current clipping region with a rectangle list region.
void	excludeClipRegion (const int x, const int y, const int width, const int height) throw ()
	Excludes a rectangle to stop it being drawn into.
bool	isClipEmpty () const throw ()
	Returns true if no drawing can be done because the clip region is zero.
void	saveState () throw ()
	Saves the current graphics state on an internal stack.
void	restoreState () throw ()
	Restores a graphics state that was previously saved with saveState().
void	setOrigin (const int newOriginX, const int newOriginY) throw ()
	Moves the position of the context's origin.
void	resetToDefaultState () throw ()
	Resets the current colour, brush, and font to default settings.
bool	isVectorDevice () const throw ()
	Returns true if this context is drawing to a vector-based device, such as a printer.
juce_UseDebuggingNewOperator	Graphics (LowLevelGraphicsContext *const internalContext) throw ()
	Create a graphics that uses a given low-level renderer.
LowLevelGraphicsContext *	getInternalContext () const throw ()

---

Detailed Description

A graphics context, used for drawing a component or image.

When a Component needs painting, a Graphics context is passed to its Component::paint() method, and this you then call methods within this object to actually draw the component's content.

A Graphics can also be created from an image, to allow drawing directly onto that image.

See also:

Component::paint

---

Member Enumeration Documentation

enum Graphics::ResamplingQuality

Types of rendering quality that can be specified when drawing images.

See also:

blendImage, Graphics::setImageResamplingQuality

Enumerator:

lowResamplingQuality	Just uses a nearest-neighbour algorithm for resampling.
mediumResamplingQuality	Uses bilinear interpolation for upsampling and area-averaging for downsampling.
highResamplingQuality	Uses bicubic interpolation for upsampling and area-averaging for downsampling.

---

Constructor & Destructor Documentation

Graphics::Graphics

(

Image &

imageToDrawOnto

)

throw ()

Creates a Graphics object to draw directly onto the given image.

The graphics object that is created will be set up to draw onto the image, with the context's clipping area being the entire size of the image, and its origin being the image's origin. To draw into a subsection of an image, use the reduceClipRegion() and setOrigin() methods.

Obviously you shouldn't delete the image before this context is deleted.

Graphics::~Graphics

(

)

throw ()

Destructor.

juce_UseDebuggingNewOperator Graphics::Graphics

(

LowLevelGraphicsContext *const

internalContext

)

throw ()

Create a graphics that uses a given low-level renderer.

For internal use only.

NB. The context will NOT be deleted by this object when it is deleted.

---

Member Function Documentation

void Graphics::setColour

(

const Colour &

newColour

)

throw ()

Changes the current drawing colour.

This sets the colour that will now be used for drawing operations - it also sets the opacity to that of the colour passed-in.

If a brush is being used when this method is called, the brush will be deselected, and any subsequent drawing will be done with a solid colour brush instead.

See also:

setOpacity, setBrush

Referenced by LassoComponent< SelectableItemType >::paint().

void Graphics::setOpacity

(

const float

newOpacity

)

throw ()

Changes the opacity to use with the current colour.

If a solid colour is being used for drawing, this changes its opacity to this new value (i.e. it doesn't multiply the colour's opacity by this amount).

If a gradient is being used, this will have no effect on it.

A value of 0.0 is completely transparent, 1.0 is completely opaque.

void Graphics::setBrush

(

const Brush *const

newBrush

)

throw ()

Changes the current brush to use for drawing.

If a null pointer is passed in, the context will revert to using a solid colour for drawing (using the last colour set by setColour()).

If a brush is passed in, a copy of it will be used for subsequent drawing operations until setColour() or setBrush() is called.

See also:

SolidColourBrush, GradientBrush, ImageBrush, Brush

void Graphics::setGradientFill

(

const ColourGradient &

gradient

)

throw ()

Sets the context to use a gradient for its fill pattern.

void Graphics::setTiledImageFill	(	Image &	imageToUse,
		const int	anchorX,
		const int	anchorY,
		const float	opacity
	)			throw ()

Sets the context to use a tiled image pattern for filling.

Make sure that you don't delete this image while it's still being used by this context!

void Graphics::setFont

(

const Font &

newFont

)

throw ()

Changes the font to use for subsequent text-drawing functions.

Note there's also a setFont (float, int) method to quickly change the size and style of the current font.

See also:

drawSingleLineText, drawMultiLineText, drawTextAsPath, drawText, drawFittedText

void Graphics::setFont	(	const float	newFontHeight,
		const int	fontStyleFlags = Font::plain
	)			throw ()

Changes the size and style of the currently-selected font.

This is a convenient shortcut that changes the context's current font to a different size or style. The typeface won't be changed.

See also:

Font

void Graphics::drawSingleLineText	(	const String &	text,
		const int	startX,
		const int	baselineY
	)			const throw ()

Draws a one-line text string.

This will use the current colour (or brush) to fill the text. The font is the last one specified by setFont().

Parameters:

	text	the string to draw
	startX	the position to draw the left-hand edge of the text
	baselineY	the position of the text's baseline

See also:

drawMultiLineText, drawText, drawFittedText, GlyphArrangement::addLineOfText

void Graphics::drawMultiLineText	(	const String &	text,
		const int	startX,
		const int	baselineY,
		const int	maximumLineWidth
	)			const throw ()

Draws text across multiple lines.

This will break the text onto a new line where there's a new-line or carriage-return character, or at a word-boundary when the text becomes wider than the size specified by the maximumLineWidth parameter.

See also:

setFont, drawSingleLineText, drawFittedText, GlyphArrangement::addJustifiedText

void Graphics::drawTextAsPath	(	const String &	text,
		const AffineTransform &	transform
	)			const throw ()

Renders a string of text as a vector path.

This allows a string to be transformed with an arbitrary AffineTransform and rendered using the current colour/brush. It's much slower than the normal text methods but more accurate.

See also:

setFont

void Graphics::drawText	(	const String &	text,
		const int	x,
		const int	y,
		const int	width,
		const int	height,
		const Justification &	justificationType,
		const bool	useEllipsesIfTooBig
	)			const throw ()

Draws a line of text within a specified rectangle.

The text will be positioned within the rectangle based on the justification flags passed-in. If the string is too long to fit inside the rectangle, it will either be truncated or will have ellipsis added to its end (if the useEllipsesIfTooBig flag is true).

See also:

drawSingleLineText, drawFittedText, drawMultiLineText, GlyphArrangement::addJustifiedText

void Graphics::drawFittedText	(	const String &	text,
		const int	x,
		const int	y,
		const int	width,
		const int	height,
		const Justification &	justificationFlags,
		const int	maximumNumberOfLines,
		const float	minimumHorizontalScale = 0.7f
	)			const throw ()

Tries to draw a text string inside a given space.

This does its best to make the given text readable within the specified rectangle, so it useful for labelling things.

If the text is too big, it'll be squashed horizontally or broken over multiple lines if the maximumLinesToUse value allows this. If the text just won't fit into the space, it'll cram as much as possible in there, and put some ellipsis at the end to show that it's been truncated.

A Justification parameter lets you specify how the text is laid out within the rectangle, both horizontally and vertically.

The minimumHorizontalScale parameter specifies how much the text can be squashed horizontally to try to squeeze it into the space. If you don't want any horizontal scaling to occur, you can set this value to 1.0f.

See also:

GlyphArrangement::addFittedText

void Graphics::fillAll

(

)

const throw ()

Fills the context's entire clip region with the current colour or brush.

(See also the fillAll (const Colour&) method which is a quick way of filling it with a given colour).

Referenced by LassoComponent< SelectableItemType >::paint().

void Graphics::fillAll

(

const Colour &

colourToUse

)

const throw ()

Fills the context's entire clip region with a given colour.

This leaves the context's current colour and brush unchanged, it just uses the specified colour temporarily.

void Graphics::fillRect	(	int	x,
		int	y,
		int	width,
		int	height
	)			const throw ()

Fills a rectangle with the current colour or brush.

See also:

drawRect, fillRoundedRectangle

void Graphics::fillRect

(

const Rectangle &

rectangle

)

const throw ()

Fills a rectangle with the current colour or brush.

void Graphics::fillRect	(	const float	x,
		const float	y,
		const float	width,
		const float	height
	)			const throw ()

Fills a rectangle with the current colour or brush.

This uses sub-pixel positioning so is slower than the fillRect method which takes integer co-ordinates.

void Graphics::fillRoundedRectangle	(	const float	x,
		const float	y,
		const float	width,
		const float	height,
		const float	cornerSize
	)			const throw ()

Uses the current colour or brush to fill a rectangle with rounded corners.

See also:

drawRoundedRectangle, Path::addRoundedRectangle

void Graphics::fillRoundedRectangle	(	const Rectangle &	rectangle,
		const float	cornerSize
	)			const throw ()

Uses the current colour or brush to fill a rectangle with rounded corners.

See also:

drawRoundedRectangle, Path::addRoundedRectangle

void Graphics::fillCheckerBoard	(	int	x,
		int	y,
		int	width,
		int	height,
		const int	checkWidth,
		const int	checkHeight,
		const Colour &	colour1,
		const Colour &	colour2
	)			const throw ()

Fills a rectangle with a checkerboard pattern, alternating between two colours.

void Graphics::drawRect	(	const int	x,
		const int	y,
		const int	width,
		const int	height,
		const int	lineThickness = 1
	)			const throw ()

Draws four lines to form a rectangular outline, using the current colour or brush.

The lines are drawn inside the given rectangle, and greater line thicknesses extend inwards.

See also:

fillRect

Referenced by LassoComponent< SelectableItemType >::paint().

void Graphics::drawRect	(	const float	x,
		const float	y,
		const float	width,
		const float	height,
		const float	lineThickness = 1.0f
	)			const throw ()

Draws four lines to form a rectangular outline, using the current colour or brush.

The lines are drawn inside the given rectangle, and greater line thicknesses extend inwards.

See also:

fillRect

void Graphics::drawRect	(	const Rectangle &	rectangle,
		const int	lineThickness = 1
	)			const throw ()

Draws four lines to form a rectangular outline, using the current colour or brush.

The lines are drawn inside the given rectangle, and greater line thicknesses extend inwards.

See also:

fillRect

void Graphics::drawRoundedRectangle	(	const float	x,
		const float	y,
		const float	width,
		const float	height,
		const float	cornerSize,
		const float	lineThickness
	)			const throw ()

Uses the current colour or brush to draw the outline of a rectangle with rounded corners.

See also:

fillRoundedRectangle, Path::addRoundedRectangle

void Graphics::drawRoundedRectangle	(	const Rectangle &	rectangle,
		const float	cornerSize,
		const float	lineThickness
	)			const throw ()

Uses the current colour or brush to draw the outline of a rectangle with rounded corners.

See also:

fillRoundedRectangle, Path::addRoundedRectangle

void Graphics::drawBevel	(	const int	x,
		const int	y,
		const int	width,
		const int	height,
		const int	bevelThickness,
		const Colour &	topLeftColour = Colours::white,
		const Colour &	bottomRightColour = Colours::black,
		const bool	useGradient = true,
		const bool	sharpEdgeOnOutside = true
	)			const throw ()

Draws a 3D raised (or indented) bevel using two colours.

The bevel is drawn inside the given rectangle, and greater bevel thicknesses extend inwards.

The top-left colour is used for the top- and left-hand edges of the bevel; the bottom-right colour is used for the bottom- and right-hand edges.

If useGradient is true, then the bevel fades out to make it look more curved and less angular. If sharpEdgeOnOutside is true, the outside of the bevel is sharp, and it fades towards the centre; if sharpEdgeOnOutside is false, then the centre edges are sharp and it fades towards the outside.

void Graphics::setPixel	(	int	x,
		int	y
	)			const throw ()

Draws a pixel using the current colour or brush.

void Graphics::fillEllipse	(	const float	x,
		const float	y,
		const float	width,
		const float	height
	)			const throw ()

Fills an ellipse with the current colour or brush.

The ellipse is drawn to fit inside the given rectangle.

See also:

drawEllipse, Path::addEllipse

void Graphics::drawEllipse	(	const float	x,
		const float	y,
		const float	width,
		const float	height,
		const float	lineThickness
	)			const throw ()

Draws an elliptical stroke using the current colour or brush.

See also:

fillEllipse, Path::addEllipse

void Graphics::drawLine	(	float	startX,
		float	startY,
		float	endX,
		float	endY
	)			const throw ()

Draws a line between two points.

The line is 1 pixel wide and drawn with the current colour or brush.

void Graphics::drawLine	(	const float	startX,
		const float	startY,
		const float	endX,
		const float	endY,
		const float	lineThickness
	)			const throw ()

Draws a line between two points with a given thickness.

See also:

Path::addLineSegment

void Graphics::drawLine

(

const Line &

line

)

const throw ()

Draws a line between two points.

The line is 1 pixel wide and drawn with the current colour or brush.

void Graphics::drawLine	(	const Line &	line,
		const float	lineThickness
	)			const throw ()

Draws a line between two points with a given thickness.

See also:

Path::addLineSegment

void Graphics::drawDashedLine	(	const float	startX,
		const float	startY,
		const float	endX,
		const float	endY,
		const float *const	dashLengths,
		const int	numDashLengths,
		const float	lineThickness = 1.0f
	)			const throw ()

Draws a dashed line using a custom set of dash-lengths.

Parameters:

	startX	the line's start x co-ordinate
	startY	the line's start y co-ordinate
	endX	the line's end x co-ordinate
	endY	the line's end y co-ordinate
	dashLengths	a series of lengths to specify the on/off lengths - e.g. { 4, 5, 6, 7 } will draw a line of 4 pixels, skip 5 pixels, draw 6 pixels, skip 7 pixels, and then repeat.
	numDashLengths	the number of elements in the array (this must be an even number).
	lineThickness	the thickness of the line to draw

See also:

PathStrokeType::createDashedStroke

void Graphics::drawVerticalLine	(	const int	x,
		float	top,
		float	bottom
	)			const throw ()

Draws a vertical line of pixels at a given x position.

The x position is an integer, but the top and bottom of the line can be sub-pixel positions, and these will be anti-aliased if necessary.

void Graphics::drawHorizontalLine	(	const int	y,
		float	left,
		float	right
	)			const throw ()

Draws a horizontal line of pixels at a given y position.

The y position is an integer, but the left and right ends of the line can be sub-pixel positions, and these will be anti-aliased if necessary.

void Graphics::fillPath	(	const Path &	path,
		const AffineTransform &	transform = AffineTransform::identity
	)			const throw ()

Fills a path using the currently selected colour or brush.

void Graphics::strokePath	(	const Path &	path,
		const PathStrokeType &	strokeType,
		const AffineTransform &	transform = AffineTransform::identity
	)			const throw ()

Draws a path's outline using the currently selected colour or brush.

void Graphics::drawArrow	(	const float	startX,
		const float	startY,
		const float	endX,
		const float	endY,
		const float	lineThickness,
		const float	arrowheadWidth,
		const float	arrowheadLength
	)			const throw ()

Draws a line with an arrowhead.

Parameters:

	startX	the line's start x co-ordinate
	startY	the line's start y co-ordinate
	endX	the line's end x co-ordinate (the tip of the arrowhead)
	endY	the line's end y co-ordinate (the tip of the arrowhead)
	lineThickness	the thickness of the line
	arrowheadWidth	the width of the arrow head (perpendicular to the line)
	arrowheadLength	the length of the arrow head (along the length of the line)

void Graphics::setImageResamplingQuality

(

const ResamplingQuality

newQuality

)

throw ()

Changes the quality that will be used when resampling images.

By default a Graphics object will be set to mediumRenderingQuality.

See also:

Graphics::drawImage, Graphics::drawImageTransformed, Graphics::drawImageWithin

void Graphics::drawImageAt	(	const Image *const	imageToDraw,
		const int	topLeftX,
		const int	topLeftY,
		const bool	fillAlphaChannelWithCurrentBrush = false
	)			const throw ()

Draws an image.

This will draw the whole of an image, positioning its top-left corner at the given co-ordinates, and keeping its size the same. This is the simplest image drawing method - the others give more control over the scaling and clipping of the images.

Images are composited using the context's current opacity, so if you don't want it to be drawn semi-transparently, be sure to call setOpacity (1.0f) (or setColour() with an opaque colour) before drawing images.

void Graphics::drawImage	(	const Image *const	imageToDraw,
		int	destX,
		int	destY,
		int	destWidth,
		int	destHeight,
		int	sourceX,
		int	sourceY,
		int	sourceWidth,
		int	sourceHeight,
		const bool	fillAlphaChannelWithCurrentBrush = false
	)			const throw ()

Draws part of an image, rescaling it to fit in a given target region.

The specified area of the source image is rescaled and drawn to fill the specifed destination rectangle.

Images are composited using the context's current opacity, so if you don't want it to be drawn semi-transparently, be sure to call setOpacity (1.0f) (or setColour() with an opaque colour) before drawing images.

Parameters:

	imageToDraw	the image to overlay
	destX	the left of the destination rectangle
	destY	the top of the destination rectangle
	destWidth	the width of the destination rectangle
	destHeight	the height of the destination rectangle
	sourceX	the left of the rectangle to copy from the source image
	sourceY	the top of the rectangle to copy from the source image
	sourceWidth	the width of the rectangle to copy from the source image
	sourceHeight	the height of the rectangle to copy from the source image
	fillAlphaChannelWithCurrentBrush	if true, then instead of drawing the source image's pixels, the source image's alpha channel is used as a mask with which to fill the destination using the current colour or brush. (If the source is has no alpha channel, then it will just fill the target with a solid rectangle)

See also:

setImageResamplingQuality, drawImageAt, drawImageWithin, fillAlphaMap

void Graphics::drawImageTransformed	(	const Image *const	imageToDraw,
		int	sourceClipX,
		int	sourceClipY,
		int	sourceClipWidth,
		int	sourceClipHeight,
		const AffineTransform &	transform,
		const bool	fillAlphaChannelWithCurrentBrush = false
	)			const throw ()

Draws part of an image, having applied an affine transform to it.

This lets you throw the image around in some wacky ways, rotate it, shear, scale it, etc.

A clipping subregion is specified within the source image and no pixels outside this region will be used.

Images are composited using the context's current opacity, so if you don't want it to be drawn semi-transparently, be sure to call setOpacity (1.0f) (or setColour() with an opaque colour) before drawing images.

If fillAlphaChannelWithCurrentBrush is set to true, then the image's RGB channels are ignored and it is filled with the current brush, masked by its alpha channel.

See also:

setImageResamplingQuality, drawImage

void Graphics::drawImageWithin	(	const Image *const	imageToDraw,
		const int	destX,
		const int	destY,
		const int	destWidth,
		const int	destHeight,
		const RectanglePlacement &	placementWithinTarget,
		const bool	fillAlphaChannelWithCurrentBrush = false
	)			const throw ()

Draws an image to fit within a designated rectangle.

If the image is too big or too small for the space, it will be rescaled to fit as nicely as it can do without affecting its aspect ratio. It will then be placed within the target rectangle according to the justification flags specified.

Parameters:

	imageToDraw	the source image to draw
	destX	top-left of the target rectangle to fit it into
	destY	top-left of the target rectangle to fit it into
	destWidth	size of the target rectangle to fit the image into
	destHeight	size of the target rectangle to fit the image into
	placementWithinTarget	this specifies how the image should be positioned within the target rectangle - see the RectanglePlacement class for more details about this.
	fillAlphaChannelWithCurrentBrush	if true, then instead of drawing the image, just its alpha channel will be used as a mask with which to draw with the current brush or colour. This is similar to fillAlphaMap(), and see also drawImage()

See also:

setImageResamplingQuality, drawImage, drawImageTransformed, drawImageAt, RectanglePlacement

const Rectangle Graphics::getClipBounds

(

)

const throw ()

Returns the position of the bounding box for the current clipping region.

See also:

getClipRegion, clipRegionIntersects

bool Graphics::clipRegionIntersects	(	const int	x,
		const int	y,
		const int	width,
		const int	height
	)			const throw ()

Checks whether a rectangle overlaps the context's clipping region.

If this returns false, no part of the given area can be drawn onto, so this method can be used to optimise a component's paint() method, by letting it avoid drawing complex objects that aren't within the region being repainted.

bool Graphics::reduceClipRegion	(	const int	x,
		const int	y,
		const int	width,
		const int	height
	)			throw ()

Intersects the current clipping region with another region.

Returns:

true if the resulting clipping region is non-zero in size

See also:

setOrigin, clipRegionIntersects, getClipLeft, getClipRight, getClipWidth, getClipHeight

bool Graphics::reduceClipRegion

(

const RectangleList &

clipRegion

)

throw ()

Intersects the current clipping region with a rectangle list region.

Returns:

true if the resulting clipping region is non-zero in size

See also:

setOrigin, clipRegionIntersects, getClipLeft, getClipRight, getClipWidth, getClipHeight

void Graphics::excludeClipRegion	(	const int	x,
		const int	y,
		const int	width,
		const int	height
	)			throw ()

Excludes a rectangle to stop it being drawn into.

bool Graphics::isClipEmpty

(

)

const throw ()

Returns true if no drawing can be done because the clip region is zero.

void Graphics::saveState

(

)

throw ()

Saves the current graphics state on an internal stack.

To restore the state, use restoreState().

void Graphics::restoreState

(

)

throw ()

Restores a graphics state that was previously saved with saveState().

void Graphics::setOrigin	(	const int	newOriginX,
		const int	newOriginY
	)			throw ()

Moves the position of the context's origin.

This changes the position that the context considers to be (0, 0) to the specified position.

So if you call setOrigin (100, 100), then the position that was previously referred to as (100, 100) will subsequently be considered to be (0, 0).

See also:

reduceClipRegion

void Graphics::resetToDefaultState

(

)

throw ()

Resets the current colour, brush, and font to default settings.

bool Graphics::isVectorDevice

(

)

const throw ()

Returns true if this context is drawing to a vector-based device, such as a printer.

LowLevelGraphicsContext* Graphics::getInternalContext

(

)

const throw ()

For internal use only.

---

The documentation for this class was generated from the following file:

• juce_Graphics.h