Start » Filter Reference » Region » Region Basics » SetRegionFrame
Advanced| Module: | FoundationLite |
|---|
Changes the width and the height of a region's frame (but does not rescale the content).
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
ioRegion | Region | ||
 |
inWidth | Integer | 0 - 65535 | New frame width |
|
inHeight | Integer | 0 - 65535 | New frame height |
Description
The operation sets the region frame's width and height to new values, while it does not change the location of any of the region pixels. Note that all of the region pixels have to be contained within region frame's dimensions. If this is not the case with selected dimensions, an error with appropriate description occurs.
Examples
 |
 |
SetRegionFrame used to change dimensions from 150x150 to 300x300.
Errors
This filter can throw an exception to report error. Read how to deal with errors in Error Handling.
List of possible exceptions:
| Error type | Description |
|---|---|
| DomainError | Resulting region isn't contained in new dimensions in SetRegionFrame. |
Complexity Level
This filter is available on Advanced Complexity Level.
See Also
- CropRegion – Creates a region from a rectangular fragment of another one.