> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-framework/modularity/image-manipulation/reference/built-in-functions/imageoverlay.md).

# ImageOverlay

## Syntax

```
ImageOverlay( image1, image2 [, rule] [, transparency] )
```

Or as a member:

```
someImage.overlay( imageToDraw [, rule] [, transparency] )
```

## Arguments

| Name         | Type    | Required | Default   | Description                                                                     |
| ------------ | ------- | -------- | --------- | ------------------------------------------------------------------------------- |
| image1       | any     | Yes      |           | The base image to overlay onto. Can be a `BoxImage` object or image name.       |
| image2       | any     | Yes      |           | The image to overlay. Can be a `BoxImage` object or image name.                 |
| rule         | string  | No       | SRC\_OVER | The compositing rule for overlay (e.g., "SRC\_OVER", "SRC\_ATOP").              |
| transparency | numeric | No       | 0.25      | The transparency level for the overlay (0.0 = fully transparent, 1.0 = opaque). |

## Returns

`BoxImage` — The base image with the overlay applied.

## Description

Overlays one image (`image2`) onto another (`image1`) using the specified compositing rule and transparency. This allows for blending images with various effects, such as watermarking or combining graphics.

## Example

```boxlang
// Overlay image2 onto image1 with default rule and transparency
result = ImageOverlay( image1, image2 );

// Overlay with custom rule and transparency
result = ImageOverlay( image1, image2, "SRC_ATOP", 0.5 );

// As a member function
image1.overlay( image2, "SRC_OVER", 0.75 );
```

## Related BIFs

* ImageCopy
* ImageDrawImage
* ImageNew

## Notes

* Both `image1` and `image2` can be `BoxImage` objects or the names of images in the current context.
* The `rule` argument determines how the overlay is composited. Common values include "SRC\_OVER" and "SRC\_ATOP".
* The operation modifies the base image in place when used as a member function.
* Returns the modified image object for chaining or further processing.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://boxlang.ortusbooks.com/boxlang-framework/modularity/image-manipulation/reference/built-in-functions/imageoverlay.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.