API Reference
Struct
ImageRegion
Defines an integer region within an image.
Inheritance
- ValueType
- ImageRegion
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property DetectedSymbol.SearchRegion
- Method ImageRegion.ClipTo
- Property ScanOptions.Region
Accepted by parameters
- Method ImageRegion.Equals
- Method ImageRegion.op_Equality
- Method ImageRegion.op_Equality
- Method ImageRegion.op_Inequality
- Method ImageRegion.op_Inequality
Constructors
public ImageRegion(Int32 x, Int32 y, Int32 width, Int32 height) #Creates an image region.
Parameters
- x System.Int32
- y System.Int32
- width System.Int32
- height System.Int32
Methods
public Nullable<ImageRegion> ClipTo(Int32 imageWidth, Int32 imageHeight) #Returns:
Nullable<ImageRegion>Returns the intersection with the supplied image dimensions, or null when there is no overlap.
Parameters
- imageWidth System.Int32
- imageHeight System.Int32
Equals 2 overloads
public override Int32 GetHashCode() #Returns:
Int32op_Equality(CodeGlyphX.ImageRegion left, CodeGlyphX.ImageRegion right) #Compares two regions.
Parameters
- left CodeGlyphX.ImageRegion
- right CodeGlyphX.ImageRegion
op_Inequality(CodeGlyphX.ImageRegion left, CodeGlyphX.ImageRegion right) #Compares two regions.
Parameters
- left CodeGlyphX.ImageRegion
- right CodeGlyphX.ImageRegion
public override String ToString() #Returns:
StringInherited Methods
Properties
public Int32 X { get; } #Gets the horizontal origin.
public Int32 Y { get; } #Gets the vertical origin.
public Int32 Width { get; } #Gets the region width.
public Int32 Height { get; } #Gets the region height.
public Int32 Right { get; } #Gets the exclusive right edge.
public Int32 Bottom { get; } #Gets the exclusive bottom edge.