Struct NppiRect
2D Rectangle
This struct contains position and size information of a rectangle in
two space.
The rectangle's position is usually signified by the coordinate of its
upper-left corner.
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.ReferenceEquals(System.Object, System.Object)
Assembly: NPP.dll
Syntax
Constructors
|
Improve this Doc
View Source
NppiRect(NppiPoint, NppiSize)
Declaration
public NppiRect(NppiPoint aPoint, NppiSize aSize)
Parameters
|
Improve this Doc
View Source
NppiRect(Int32, Int32, Int32, Int32)
Declaration
public NppiRect(int aX, int aY, int aWidth, int aHeight)
Parameters
| Type |
Name |
Description |
| System.Int32 |
aX |
|
| System.Int32 |
aY |
|
| System.Int32 |
aWidth |
|
| System.Int32 |
aHeight |
|
Fields
|
Improve this Doc
View Source
height
Declaration
Field Value
| Type |
Description |
| System.Int32 |
|
|
Improve this Doc
View Source
width
Declaration
Field Value
| Type |
Description |
| System.Int32 |
|
|
Improve this Doc
View Source
x
x-coordinate of upper left corner.
Declaration
Field Value
| Type |
Description |
| System.Int32 |
|
|
Improve this Doc
View Source
y
y-coordinate of upper left corner.
Declaration
Field Value
| Type |
Description |
| System.Int32 |
|
Properties
|
Improve this Doc
View Source
Bottom
Gets the y-coordinate that is the sum of the y and height values - 1.
Declaration
public int Bottom { get; }
Property Value
| Type |
Description |
| System.Int32 |
|
|
Improve this Doc
View Source
IsEmtpy
Tests whether all numeric properties of this Rectangle have values of zero.
Declaration
public bool IsEmtpy { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Left
Gets the x-coordinate of the left edge.
Declaration
Property Value
| Type |
Description |
| System.Int32 |
|
|
Improve this Doc
View Source
Location
Returns the x and y component as NppiPoint
Declaration
public NppiPoint Location { get; set; }
Property Value
|
Improve this Doc
View Source
Right
Gets the x-coordinate that is the sum of x and width values - 1.
Declaration
public int Right { get; }
Property Value
| Type |
Description |
| System.Int32 |
|
|
Improve this Doc
View Source
Size
Returns the width and height component as NppiSize
Declaration
public NppiSize Size { get; set; }
Property Value
|
Improve this Doc
View Source
Top
Gets the y-coordinate of the top edge.
Declaration
Property Value
| Type |
Description |
| System.Int32 |
|
Methods
|
Improve this Doc
View Source
Add(NppiPoint, NppiRect)
Declaration
public static NppiRect Add(NppiPoint src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Add(NppiRect, NppiPoint)
Declaration
public static NppiRect Add(NppiRect src, NppiPoint value)
Parameters
Returns
|
Improve this Doc
View Source
Add(NppiRect, NppiRect)
Declaration
public static NppiRect Add(NppiRect src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Add(NppiRect, NppiSize)
Declaration
public static NppiRect Add(NppiRect src, NppiSize value)
Parameters
Returns
|
Improve this Doc
View Source
Add(NppiRect, Int32)
Declaration
public static NppiRect Add(NppiRect src, int value)
Parameters
| Type |
Name |
Description |
| NppiRect |
src |
|
| System.Int32 |
value |
|
Returns
|
Improve this Doc
View Source
Add(NppiSize, NppiRect)
Declaration
public static NppiRect Add(NppiSize src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Add(Int32, NppiRect)
Declaration
public static NppiRect Add(int src, NppiRect value)
Parameters
| Type |
Name |
Description |
| System.Int32 |
src |
|
| NppiRect |
value |
|
Returns
|
Improve this Doc
View Source
Contains(NppiPoint)
Determines if the specified point is contained within this Rectangle structure.
Declaration
public bool Contains(NppiPoint point)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Contains(NppiRect)
Determines if the rectangular region represented by rect is entirely contained within this Rectangle structure.
Declaration
public bool Contains(NppiRect rect)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Contains(Int32, Int32)
Determines if the specified point is contained within this Rectangle structure.
Declaration
public bool Contains(int px, int py)
Parameters
| Type |
Name |
Description |
| System.Int32 |
px |
|
| System.Int32 |
py |
|
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Deflate(NppiSize)
Reduces this Rectangle by the specified amount.
Declaration
public void Deflate(NppiSize val)
Parameters
|
Improve this Doc
View Source
Deflate(Int32)
Reduces this Rectangle by the specified amount.
Declaration
public void Deflate(int val)
Parameters
| Type |
Name |
Description |
| System.Int32 |
val |
|
|
Improve this Doc
View Source
Deflate(Int32, Int32)
Reduces this Rectangle by the specified amount.
Declaration
public void Deflate(int valX, int valY)
Parameters
| Type |
Name |
Description |
| System.Int32 |
valX |
|
| System.Int32 |
valY |
|
|
Improve this Doc
View Source
Divide(NppiPoint, NppiRect)
Declaration
public static NppiRect Divide(NppiPoint src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Divide(NppiRect, NppiPoint)
Declaration
public static NppiRect Divide(NppiRect src, NppiPoint value)
Parameters
Returns
|
Improve this Doc
View Source
Divide(NppiRect, NppiRect)
Declaration
public static NppiRect Divide(NppiRect src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Divide(NppiRect, NppiSize)
Declaration
public static NppiRect Divide(NppiRect src, NppiSize value)
Parameters
Returns
|
Improve this Doc
View Source
Divide(NppiRect, Int32)
Declaration
public static NppiRect Divide(NppiRect src, int value)
Parameters
| Type |
Name |
Description |
| NppiRect |
src |
|
| System.Int32 |
value |
|
Returns
|
Improve this Doc
View Source
Divide(NppiSize, NppiRect)
Declaration
public static NppiRect Divide(NppiSize src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Divide(Int32, NppiRect)
Declaration
public static NppiRect Divide(int src, NppiRect value)
Parameters
| Type |
Name |
Description |
| System.Int32 |
src |
|
| NppiRect |
value |
|
Returns
|
Improve this Doc
View Source
Equals(NppiRect)
Declaration
public bool Equals(NppiRect value)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Equals(Object)
Declaration
public override bool Equals(object obj)
Parameters
| Type |
Name |
Description |
| System.Object |
obj |
|
Returns
| Type |
Description |
| System.Boolean |
|
Overrides
System.ValueType.Equals(System.Object)
|
Improve this Doc
View Source
GetHashCode()
Declaration
public override int GetHashCode()
Returns
| Type |
Description |
| System.Int32 |
|
Overrides
System.ValueType.GetHashCode()
|
Improve this Doc
View Source
GetResizeTiledSourceOffset(NppiRect)
Helper function that can be used when tiling a destination image with a source image using multiple Resize calls.
oSrcRectROI and oDstRectROI widths and heights should remain unmodified even if they will overlap source and destination
image sizes.oDstRectROI offsets should be set to the destination offset of the new tile.
Resize function processing will stop when source or destination image sizes are reached, any unavailable source image pixels
beyond source image size will be border replicated.There is no particular association assumed between source and destination image locations.
The values of oSrcRectROI.x and oSrcRectROI.y are ignored during this function call.
Declaration
public NppiPoint GetResizeTiledSourceOffset(NppiRect oDstRectROI)
Parameters
| Type |
Name |
Description |
| NppiRect |
oDstRectROI |
Region of interest in the destination image (may overlap destination image size width and height)
|
Returns
| Type |
Description |
| NppiPoint |
NppiPoint object that will contain the new source image ROI offset to be used in the nppiResize call to generate that tile.
|
|
Improve this Doc
View Source
Inflate(NppiSize)
Enlarges this Rectangle by the specified amount.
Declaration
public void Inflate(NppiSize val)
Parameters
|
Improve this Doc
View Source
Inflate(Int32)
Enlarges this Rectangle by the specified amount.
Declaration
public void Inflate(int val)
Parameters
| Type |
Name |
Description |
| System.Int32 |
val |
|
|
Improve this Doc
View Source
Inflate(Int32, Int32)
Enlarges this Rectangle by the specified amount.
Declaration
public void Inflate(int valX, int valY)
Parameters
| Type |
Name |
Description |
| System.Int32 |
valX |
|
| System.Int32 |
valY |
|
|
Improve this Doc
View Source
Intersect(NppiRect)
Replaces this Rectangle with the intersection of itself and the specified Rectangle.
Declaration
public void Intersect(NppiRect rect)
Parameters
|
Improve this Doc
View Source
Intersect(NppiRect, NppiRect)
Returns a third Rectangle structure that represents the intersection of two other Rectangle structures.If there is no intersection, an empty Rectangle is returned.
Declaration
public static NppiRect Intersect(NppiRect rectA, NppiRect rectB)
Parameters
Returns
|
Improve this Doc
View Source
IntersectsWith(NppiRect)
Determines if this rectangle intersects with rect.
Declaration
public bool IntersectsWith(NppiRect rect)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Multiply(NppiPoint, NppiRect)
Declaration
public static NppiRect Multiply(NppiPoint src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(NppiRect, NppiPoint)
Declaration
public static NppiRect Multiply(NppiRect src, NppiPoint value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(NppiRect, NppiRect)
Declaration
public static NppiRect Multiply(NppiRect src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(NppiRect, NppiSize)
Declaration
public static NppiRect Multiply(NppiRect src, NppiSize value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(NppiRect, Int32)
Declaration
public static NppiRect Multiply(NppiRect src, int value)
Parameters
| Type |
Name |
Description |
| NppiRect |
src |
|
| System.Int32 |
value |
|
Returns
|
Improve this Doc
View Source
Multiply(NppiSize, NppiRect)
Declaration
public static NppiRect Multiply(NppiSize src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(Int32, NppiRect)
Declaration
public static NppiRect Multiply(int src, NppiRect value)
Parameters
| Type |
Name |
Description |
| System.Int32 |
src |
|
| NppiRect |
value |
|
Returns
|
Improve this Doc
View Source
Subtract(NppiPoint, NppiRect)
Declaration
public static NppiRect Subtract(NppiPoint src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Subtract(NppiRect, NppiPoint)
Declaration
public static NppiRect Subtract(NppiRect src, NppiPoint value)
Parameters
Returns
|
Improve this Doc
View Source
Subtract(NppiRect, NppiRect)
Declaration
public static NppiRect Subtract(NppiRect src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Subtract(NppiRect, NppiSize)
Declaration
public static NppiRect Subtract(NppiRect src, NppiSize value)
Parameters
Returns
|
Improve this Doc
View Source
Subtract(NppiRect, Int32)
Declaration
public static NppiRect Subtract(NppiRect src, int value)
Parameters
| Type |
Name |
Description |
| NppiRect |
src |
|
| System.Int32 |
value |
|
Returns
|
Improve this Doc
View Source
Subtract(NppiSize, NppiRect)
Declaration
public static NppiRect Subtract(NppiSize src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Subtract(Int32, NppiRect)
Declaration
public static NppiRect Subtract(int src, NppiRect value)
Parameters
| Type |
Name |
Description |
| System.Int32 |
src |
|
| NppiRect |
value |
|
Returns
|
Improve this Doc
View Source
ToString()
Declaration
public override string ToString()
Returns
| Type |
Description |
| System.String |
|
Overrides
System.ValueType.ToString()
Operators
|
Improve this Doc
View Source
Addition(NppiPoint, NppiRect)
Declaration
public static NppiRect operator +(NppiPoint src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Addition(NppiRect, NppiPoint)
Declaration
public static NppiRect operator +(NppiRect src, NppiPoint value)
Parameters
Returns
|
Improve this Doc
View Source
Addition(NppiRect, NppiRect)
Declaration
public static NppiRect operator +(NppiRect src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Addition(NppiRect, NppiSize)
Declaration
public static NppiRect operator +(NppiRect src, NppiSize value)
Parameters
Returns
|
Improve this Doc
View Source
Addition(NppiRect, Int32)
Declaration
public static NppiRect operator +(NppiRect src, int value)
Parameters
| Type |
Name |
Description |
| NppiRect |
src |
|
| System.Int32 |
value |
|
Returns
|
Improve this Doc
View Source
Addition(NppiSize, NppiRect)
Declaration
public static NppiRect operator +(NppiSize src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Addition(Int32, NppiRect)
Declaration
public static NppiRect operator +(int src, NppiRect value)
Parameters
| Type |
Name |
Description |
| System.Int32 |
src |
|
| NppiRect |
value |
|
Returns
|
Improve this Doc
View Source
Division(NppiPoint, NppiRect)
Declaration
public static NppiRect operator /(NppiPoint src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Division(NppiRect, NppiPoint)
Declaration
public static NppiRect operator /(NppiRect src, NppiPoint value)
Parameters
Returns
|
Improve this Doc
View Source
Division(NppiRect, NppiRect)
Declaration
public static NppiRect operator /(NppiRect src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Division(NppiRect, NppiSize)
Declaration
public static NppiRect operator /(NppiRect src, NppiSize value)
Parameters
Returns
|
Improve this Doc
View Source
Division(NppiRect, Int32)
Declaration
public static NppiRect operator /(NppiRect src, int value)
Parameters
| Type |
Name |
Description |
| NppiRect |
src |
|
| System.Int32 |
value |
|
Returns
|
Improve this Doc
View Source
Division(NppiSize, NppiRect)
Declaration
public static NppiRect operator /(NppiSize src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Division(Int32, NppiRect)
Declaration
public static NppiRect operator /(int src, NppiRect value)
Parameters
| Type |
Name |
Description |
| System.Int32 |
src |
|
| NppiRect |
value |
|
Returns
|
Improve this Doc
View Source
Equality(NppiRect, NppiRect)
Declaration
public static bool operator ==(NppiRect src, NppiRect value)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Inequality(NppiRect, NppiRect)
Declaration
public static bool operator !=(NppiRect src, NppiRect value)
Parameters
Returns
| Type |
Description |
| System.Boolean |
|
|
Improve this Doc
View Source
Multiply(NppiPoint, NppiRect)
Declaration
public static NppiRect operator *(NppiPoint src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(NppiRect, NppiPoint)
Declaration
public static NppiRect operator *(NppiRect src, NppiPoint value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(NppiRect, NppiRect)
Declaration
public static NppiRect operator *(NppiRect src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(NppiRect, NppiSize)
Declaration
public static NppiRect operator *(NppiRect src, NppiSize value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(NppiRect, Int32)
Declaration
public static NppiRect operator *(NppiRect src, int value)
Parameters
| Type |
Name |
Description |
| NppiRect |
src |
|
| System.Int32 |
value |
|
Returns
|
Improve this Doc
View Source
Multiply(NppiSize, NppiRect)
Declaration
public static NppiRect operator *(NppiSize src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Multiply(Int32, NppiRect)
Declaration
public static NppiRect operator *(int src, NppiRect value)
Parameters
| Type |
Name |
Description |
| System.Int32 |
src |
|
| NppiRect |
value |
|
Returns
|
Improve this Doc
View Source
Subtraction(NppiPoint, NppiRect)
Declaration
public static NppiRect operator -(NppiPoint src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Subtraction(NppiRect, NppiPoint)
Declaration
public static NppiRect operator -(NppiRect src, NppiPoint value)
Parameters
Returns
|
Improve this Doc
View Source
Subtraction(NppiRect, NppiRect)
Declaration
public static NppiRect operator -(NppiRect src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Subtraction(NppiRect, NppiSize)
Declaration
public static NppiRect operator -(NppiRect src, NppiSize value)
Parameters
Returns
|
Improve this Doc
View Source
Subtraction(NppiRect, Int32)
Declaration
public static NppiRect operator -(NppiRect src, int value)
Parameters
| Type |
Name |
Description |
| NppiRect |
src |
|
| System.Int32 |
value |
|
Returns
|
Improve this Doc
View Source
Subtraction(NppiSize, NppiRect)
Declaration
public static NppiRect operator -(NppiSize src, NppiRect value)
Parameters
Returns
|
Improve this Doc
View Source
Subtraction(Int32, NppiRect)
Declaration
public static NppiRect operator -(int src, NppiRect value)
Parameters
| Type |
Name |
Description |
| System.Int32 |
src |
|
| NppiRect |
value |
|
Returns