Back to Aurora Vision Library website

You are here: Start » Function Reference » Image » Image Drawing » DrawImage

DrawImage


Header: AVL.h
Namespace: avl
Module: FoundationLite

Draws an image on another one.

Syntax

C++
C#
 
void avl::DrawImage
(
	avl::Image& ioImage,
	const avl::Image& inDrawnImage,
	const avl::Location& inLocation
)

Parameters

Name Type Default Description
Input will be modified ioImage Image&
Input value inDrawnImage const Image& Image to be pasted on ioImage
Input value inLocation const Location& Location at which the image will be pasted

Description

The operation draws the inDrawnImage on the inImage so that the upper-left corner of the inDrawnImage is aligned at the inLocation of the inImage.

Examples

The DrawImage used to draw an image on another, empty image.

Errors

List of possible exceptions:

Error type Description
DomainError Incompatible image depths in DrawImage.

See Also

  • DrawGridImage – Draws an image as a tile on an image considered to be a grid of tiles.