PCL
Bitmap Bitwise Logical Operations

Functions

void pcl::Bitmap::And (const Bitmap &src)
 
void pcl::Bitmap::And (const pcl::Point &p, const Bitmap &src)
 
void pcl::Bitmap::And (const pcl::Point &p, const Bitmap &src, const pcl::Rect &r)
 
void pcl::Bitmap::And (const pcl::Rect &rect, RGBA andWith)
 
void pcl::Bitmap::And (RGBA andWith)
 
void pcl::Bitmap::Copy (const Bitmap &src)
 
void pcl::Bitmap::Copy (const pcl::Point &p, const Bitmap &src)
 
void pcl::Bitmap::Copy (const pcl::Point &p, const Bitmap &src, const pcl::Rect &r)
 
void pcl::Bitmap::Fill (const pcl::Rect &rect, RGBA fillWith)
 
void pcl::Bitmap::Fill (RGBA fillWith)
 
void pcl::Bitmap::Invert ()
 
void pcl::Bitmap::Invert (const pcl::Rect &rect)
 
void pcl::Bitmap::InvertRect ()
 
void pcl::Bitmap::InvertRect (const pcl::Rect &rect)
 
void pcl::Bitmap::Or (const Bitmap &src)
 
void pcl::Bitmap::Or (const pcl::Point &p, const Bitmap &src)
 
void pcl::Bitmap::Or (const pcl::Point &p, const Bitmap &src, const pcl::Rect &r)
 
void pcl::Bitmap::Or (const pcl::Rect &rect, RGBA orWith)
 
void pcl::Bitmap::Or (RGBA orWith)
 
void pcl::Bitmap::Xor (const Bitmap &src)
 
void pcl::Bitmap::Xor (const pcl::Point &p, const Bitmap &src)
 
void pcl::Bitmap::Xor (const pcl::Point &p, const Bitmap &src, const pcl::Rect &r)
 
void pcl::Bitmap::Xor (const pcl::Rect &rect, RGBA xorWith)
 
void pcl::Bitmap::Xor (RGBA xorWith)
 
void pcl::Bitmap::XorRect (const pcl::Rect &rect, RGBA xorWith)
 
void pcl::Bitmap::XorRect (RGBA xorWith)
 

Detailed Description

Function Documentation

◆ And() [1/5]

void pcl::Bitmap::And ( const Bitmap src)
inline

Replaces all pixels in this bitmap with the bitwise AND operation between their current values and the pixels of a source bitmap src. This function is equivalent to:

And( Point( 0, 0 ), src );

Definition at line 1141 of file Bitmap.h.

◆ And() [2/5]

void pcl::Bitmap::And ( const pcl::Point p,
const Bitmap src 
)
inline

Replaces a rectangular region of this bitmap with the bitwise AND operation between its current pixel values and the corresponding pixels of a source bitmap.

Parameters
pPosition of the upper left corner of the target rectangle on this bitmap.
srcSource bitmap whose pixels will be ANDed with this bitmap.

Target pixels on this bitmap are replaced with the result of the bitwise AND operation with the corresponding pixels read from the source bitmap src. Source pixels falling outside the boundaries of this bitmap are ignored.

This function is equivalent to:

And( p, src, src.Bounds() );

Definition at line 1127 of file Bitmap.h.

◆ And() [3/5]

void pcl::Bitmap::And ( const pcl::Point p,
const Bitmap src,
const pcl::Rect r 
)

Replaces a rectangular region of this bitmap with the bitwise AND operation between its current pixel values and the pixels of a corresponding region of a source bitmap.

Parameters
pPosition of the upper left corner of the target rectangle on this bitmap.
srcSource bitmap whose pixels will be ANDed with this bitmap.
rDefines the rectangular area that will be operated, in source bitmap coordinates.

Target pixels on this bitmap are replaced with the result of the bitwise AND operation with the corresponding pixels read from the source bitmap src. Source pixels falling outside the boundaries of this bitmap are ignored.

◆ And() [4/5]

void pcl::Bitmap::And ( const pcl::Rect rect,
RGBA  andWith 
)

Replaces each pixel in a rectangular region of this bitmap with the result of the bitwise AND operation between its current value and a specified constant value.

Parameters
rectRectangular region to be operated.
andWithValue to be ANDed with current pixel values.

◆ And() [5/5]

void pcl::Bitmap::And ( RGBA  andWith)
inline

Replaces each pixel in this bitmap with the result of the bitwise AND operation between its current value and a specified constant value andWith.

This function is equivalent to:

And( Bounds(), andWith );

Definition at line 1079 of file Bitmap.h.

◆ Copy() [1/3]

void pcl::Bitmap::Copy ( const Bitmap src)
inline

Copies all pixels from a source bitmap to this bitmap.

Parameters
srcSource bitmap, whose pixels will be copied to this bitmap.

Target pixels on this bitmap are replaced with pixels read from the source bitmap src. Pixels are copied at the upper left corner of this image (0,0). Source pixels falling outside the boundaries of this bitmap are ignored.

This function is equivalent to:

Copy( pcl::Point( 0, 0 ), src );

Definition at line 938 of file Bitmap.h.

◆ Copy() [2/3]

void pcl::Bitmap::Copy ( const pcl::Point p,
const Bitmap src 
)
inline

Copies all pixels from a source bitmap to the specified location on this bitmap.

Parameters
pPosition of the upper left corner of the target rectangle on this bitmap.
srcSource bitmap, whose pixels will be copied to this bitmap.

Target pixels on this bitmap are replaced with pixels read from the source bitmap src. Source pixels falling outside the boundaries of this bitmap are ignored.

This function is equivalent to:

Copy( p, src, src.Bounds() );

Definition at line 917 of file Bitmap.h.

References pcl::Bitmap::Bounds().

◆ Copy() [3/3]

void pcl::Bitmap::Copy ( const pcl::Point p,
const Bitmap src,
const pcl::Rect r 
)

Copies a region of a source bitmap to the specified location on this bitmap.

Parameters
pPosition of the upper left corner of the target rectangle on this bitmap.
srcSource bitmap, whose pixels will be copied to this bitmap.
rDefines the rectangular area that will be copied, in source bitmap coordinates.

Target pixels on this bitmap are replaced with pixels read from the source bitmap src. Source pixels falling outside the boundaries of this bitmap are ignored.

◆ Fill() [1/2]

void pcl::Bitmap::Fill ( const pcl::Rect rect,
RGBA  fillWith 
)

Fills a rectangular region of this bitmap with a constant value.

Parameters
rectRectangular region to be filled.
fillWithPixel value to fill with.

◆ Fill() [2/2]

void pcl::Bitmap::Fill ( RGBA  fillWith)
inline

Fills the entire bitmap with a constant value fillWith. This function is equivalent to:

Fill( Bounds(), fillWith );

Definition at line 961 of file Bitmap.h.

◆ Invert() [1/2]

void pcl::Bitmap::Invert ( )
inline

Inverts all pixels of this bitmap.

This function does not invert alpha pixel components, but just color components. It is equivalent to:

Invert( Bounds() );

Definition at line 1298 of file Bitmap.h.

◆ Invert() [2/2]

void pcl::Bitmap::Invert ( const pcl::Rect rect)
inline

Inverts a rectangular region of this bitmap.

Parameters
rectRectangular region to be inverted.

This function does not invert alpha pixel components, but just color components. It is equivalent to:

Xor( rect, 0x00ffffff );

Definition at line 1283 of file Bitmap.h.

◆ InvertRect() [1/2]

void pcl::Bitmap::InvertRect ( )
inline

Inverts the pixels pertaining to the bounding rectangle of this bitmap.

This function does not invert alpha pixel components, but just color components. It is equivalent to:

InvertRect( Bounds() );

Definition at line 1329 of file Bitmap.h.

◆ InvertRect() [2/2]

void pcl::Bitmap::InvertRect ( const pcl::Rect rect)
inline

Inverts the pixels pertaining to a rectangle rect defined on this bitmap.

This function does not invert alpha pixel components, but just color components. It is equivalent to:

XorRect( rect, 0x00ffffff );

Definition at line 1314 of file Bitmap.h.

◆ Or() [1/5]

void pcl::Bitmap::Or ( const Bitmap src)
inline

Replaces all pixels in this bitmap with the bitwise inclusive OR operation between their current values and the pixels of a source bitmap src. This function is equivalent to:

Or( Point( 0, 0 ), src );

Definition at line 1051 of file Bitmap.h.

◆ Or() [2/5]

void pcl::Bitmap::Or ( const pcl::Point p,
const Bitmap src 
)
inline

Replaces a rectangular region of this bitmap with the bitwise inclusive OR operation between its current pixel values and the corresponding pixels of a source bitmap.

Parameters
pPosition of the upper left corner of the target rectangle on this bitmap.
srcSource bitmap whose pixels will be ORed with this bitmap.

Target pixels on this bitmap are replaced with the result of the bitwise OR operation with the corresponding pixels read from the source bitmap src. Source pixels falling outside the boundaries of this bitmap are ignored.

This function is equivalent to:

Or( p, src, src.Bounds() );

Definition at line 1037 of file Bitmap.h.

◆ Or() [3/5]

void pcl::Bitmap::Or ( const pcl::Point p,
const Bitmap src,
const pcl::Rect r 
)

Replaces a rectangular region of this bitmap with the bitwise inclusive OR operation between its current pixel values and the pixels of a corresponding region of a source bitmap.

Parameters
pPosition of the upper left corner of the target rectangle on this bitmap.
srcSource bitmap whose pixels will be ORed with this bitmap.
rDefines the rectangular area that will be operated, in source bitmap coordinates.

Target pixels on this bitmap are replaced with the result of the bitwise OR operation with the corresponding pixels read from the source bitmap src. Source pixels falling outside the boundaries of this bitmap are ignored.

◆ Or() [4/5]

void pcl::Bitmap::Or ( const pcl::Rect rect,
RGBA  orWith 
)

Replaces each pixel in a rectangular region of this bitmap with the result of the bitwise inclusive OR operation between its current value and a specified constant value.

Parameters
rectRectangular region to be operated.
orWithValue to be ORed with current pixel values.

◆ Or() [5/5]

void pcl::Bitmap::Or ( RGBA  orWith)
inline

Replaces each pixel in this bitmap with the result of the bitwise inclusive OR operation between its current value and a specified constant value andWith.

This function is equivalent to:

Or( Bounds(), orWith );

Definition at line 989 of file Bitmap.h.

◆ Xor() [1/5]

void pcl::Bitmap::Xor ( const Bitmap src)
inline

Replaces all pixels in this bitmap with the bitwise exclusive OR (XOR) operation between their current values and the pixels of a source bitmap src. This function is equivalent to:

Xor( Point( 0, 0 ), src );

Definition at line 1231 of file Bitmap.h.

◆ Xor() [2/5]

void pcl::Bitmap::Xor ( const pcl::Point p,
const Bitmap src 
)
inline

Replaces a rectangular region of this bitmap with the bitwise exclusive OR (XOR) operation between its current pixel values and the corresponding pixels of a source bitmap.

Parameters
pPosition of the upper left corner of the target rectangle on this bitmap.
srcSource bitmap whose pixels will be XORed with this bitmap.

Target pixels on this bitmap are replaced with the result of the exclusive OR (XOR) operation with the corresponding pixels read from the source bitmap src. Source pixels falling outside the boundaries of this bitmap are ignored.

This function is equivalent to:

Xor( p, src, src.Bounds() );

Definition at line 1217 of file Bitmap.h.

◆ Xor() [3/5]

void pcl::Bitmap::Xor ( const pcl::Point p,
const Bitmap src,
const pcl::Rect r 
)

Replaces a rectangular region of this bitmap with the bitwise exclusive OR (XOR) operation between its current pixel values and the pixels of a corresponding region of a source bitmap.

Parameters
pPosition of the upper left corner of the target rectangle on this bitmap.
srcSource bitmap whose pixels will be XORed with this bitmap.
rDefines the rectangular area that will be operated, in source bitmap coordinates.

Target pixels on this bitmap are replaced with the result of the XOR operation with the corresponding pixels read from the source bitmap src. Source pixels falling outside the boundaries of this bitmap are ignored.

◆ Xor() [4/5]

void pcl::Bitmap::Xor ( const pcl::Rect rect,
RGBA  xorWith 
)

Replaces each pixel in a rectangular region of this bitmap with the result of the bitwise exclusive OR (XOR) operation between its current value and a specified constant value.

Parameters
rectRectangular region to be operated.
xorWithValue to be XORed with current pixel values.

◆ Xor() [5/5]

void pcl::Bitmap::Xor ( RGBA  xorWith)
inline

Replaces each pixel in this bitmap with the result of the bitwise exclusive OR (XOR) operation between its current value and a specified constant value xorWith.

This function is equivalent to:

Xor( Bounds(), xorWith );

Definition at line 1169 of file Bitmap.h.

◆ XorRect() [1/2]

void pcl::Bitmap::XorRect ( const pcl::Rect rect,
RGBA  xorWith 
)

Replaces the pixels pertaining to a rectangle defined on this bitmap with the bitwise exclusive OR (XOR) operation between their current values and a specified constant value.

Parameters
rectRectangle that will be operated.
xorWithValue to be XORed with current pixel values.

This function does not operate on a rectangular region; only the sides of the specified rectangle are XORed: two one-pixel columns and two one-pixel rows.

◆ XorRect() [2/2]

void pcl::Bitmap::XorRect ( RGBA  xorWith)
inline

Replaces the pixels pertaining to the bounding rectangle of this bitmap with the bitwise exclusive OR (XOR) operation between their current values and a specified constant value.

Parameters
xorWithValue to be XORed with current pixel values.

This function is equivalent to:

XorRect( Bounds(), xorWith );

Definition at line 1266 of file Bitmap.h.