MbufClear

See also

User Guide:

2D graphics context Annotating the displayed image non-destructively Camera calibration propagation

Reference:

MbufInquire MbufSetRegion MgraClear

Availability

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Not supported on:

Not supported on Matrox Indio (Update 53 or Update 68) (w)

Not supported on Matrox Concord PoE with ToE (Update 82) (z)

Fully supported on:

Fully supported on Host system (a)

Fully supported on Matrox GigE Vision driver (MIL 10, Update 25, Update 54, or Update 85)* (c)

Fully supported on Matrox Morphis (g)

Fully supported on Matrox Morphis QxT (h)

Fully supported on Matrox Orion HD (i)

Fully supported on Matrox Radient eCL (j)

Fully supported on Matrox Radient eV-CXP (MIL 10 or Update 29)* (k)

Fully supported on Matrox Solios eA/XA (l)

Fully supported on Matrox Solios ecl/xcl/ev-cl (m)

Fully supported on Matrox USB3 Vision driver (Update 19) (o)

Fully supported on Matrox RadientPro-CL (Update 7) (p)

Fully supported on Matrox Radient eV-CL (Update 27 or 74) (r)

Fully supported on Matrox Iris GTR (Update 28 or Update 68) (t)

Fully supported on Matrox Clarity UHD (Update 36 or 76) (u)

Fully supported on Matrox GenTL driver (Update 34) (v)

Fully supported on Matrox Rapixo CXP (Update 75 or Update 84) (y)

Fully supported on Matrox Rapixo CL Pro (Update 96) (aa)

* Refer to the MIL system-specific information
in the MIL Reference for the minimum update required.

For any information regarding a MIL system added during a MIL Update, see the MIL system’s release note

Available on Non-Matrox computer

Available on Matrox 4Sight-X

Available on Matrox 4Sight GP/GPm

Available on Matrox Supersight

Function map

Examples

3dgapandflush.cpp
3dmodelheightdefect.cpp
3dprofilemetrology.cpp
adaptivefiltering.cpp
alphablending.cpp
autodetect.cpp
binarybasedcircledetection.cpp
blisterpackinspection.cpp
blobmerge.cpp
bottlecapinspection.cpp
calgenchessgrid.cpp
cameraevents.cpp
cameralasercalibration.cpp
cameraonrobotarmcalibration.cpp
caninspection.cpp
charactercreator.cpp
chunkmode.cpp
cielabconversion.cpp
classcnncompletetrain.cpp
classprintedchar.cpp
classsurfacesteel.cpp
classtreeensembletrain.cpp
codegrading.cpp
colorrelativecalibration.cpp
cookiedetection.cpp
datalatch.cpp
defectdetectionexample.cpp
defectdetectionprocfunc.cpp
defectdetectionprocfunc_capandcontent.cpp
depthfromfocus.cpp
depthmapgoldentemplate.cpp
dmilmdigprocesssharedmemory.cpp
dmilmultisystem.cpp
dmilobjecttracking.cpp
dotspacing.cpp
exampleinterface.cpp
examplemanager.cpp
examplemanagerfor3d.cpp
fdklutmapmain.cpp
findimageorientation.cpp
flatfieldcorrection.cpp
foodinspectioncereal.cpp
foodinspectionmango.cpp
gumpackinspection.cpp
histogramdisplay.cpp
histogramequalizeadaptive.cpp
imageflattening.cpp
interactivebayer.cpp
irisgtrlensfocus.cpp
m3dmap.cpp
m3dmap.cs
m3dmap.vb
m3dreg.cpp
m3dreg.cs
m3dreg.vb
mapptrace.cpp
mapptrace.cs
mapptrace.vb
mbufcolor.cpp
mbufcolor.cs
mbufcolor.vb
mclass.cpp
mclass.cs
mclass.vb
mcol.cpp
mcol.cs
mcol.vb
mdigautofocus.cpp
mdigautofocus.cs
mdigautofocus.vb
mdigdoublebuffering.cpp
mdigdoublebuffering.cs
mdigdoublebuffering.vb
mdiggrabdynamic.cpp
mdiggrabmultiple.cpp
mdiggrabsequence.cpp
mdiggrabsequence.cs
mdiggrabsequence.vb
mdighandler.cpp
mdigprocess.cpp
mdigprocess.cs
mdigprocess.vb
mdigprocess16vd.cpp
mdigprocessmultiple.cpp
mdispgtkview.cpp
mdispmfcdoc.cpp
mdispoverlay.cpp
mdispoverlay.cs
mdispoverlay.vb
mdispqtview.cpp
mdispweb.cpp
mdispwindowgtk.cpp
mdispwindowqt.cpp
mechanicalpartscan.cpp
medgecustomderivatives.cpp
mgenlutfunction.cpp
milapplication.cs
milapplication.vb
milgige.cpp
mimaugment.cpp
mimbinarizeadaptive.cpp
mimdeinterlace.cpp
mimdeinterlace.cs
mimdeinterlace.vb
mimfft.cpp
mimfft.cs
mimfft.vb
mimlocatepeak1d.cpp
mimlocatepeak1d.cs
mimlocatepeak1d.vb
mimmorphic.cpp
mimwarp.cpp
mimwarp.cs
mimwarp.vb
mimwarpquadrilateral.cpp
mmoddefinemodelatangle.cpp
mocr.cpp
mocr.cs
mocr.vb
morphischannelswitchingdlg.cpp
morphology.cpp
mpatdefinemodelatangle.cpp
mpatfindmultiplemodels.cpp
mpmenu.cpp
mpprocessing.cpp
mprotateprocessing.cpp
mpwarpprocessing.cpp
mseqprocess.cpp
mseqprocess.cs
mseqprocess.vb
mthread.cpp
mthread.cs
mthread.vb
muart.cpp
multicamera.cpp
multicastmaster.cpp
multicastmonitor.cpp
multicastslave.cpp
multipledatamatrixcoderead.cpp
multiviewannotations.cpp
objectlocalization3d.cpp
offsetgain.cpp
offsetgainlutmap.cpp
packetdelay.cpp
pcbmodelmatching.cpp
photometricstereo.cpp
pointconstructions.cpp
polarizationimaging.cpp
processingfpga.cpp
productidentificationoasis.cpp
profiledisplay.cpp
projection.cpp
regionmanager.cpp
registeredgoldentemplate.cpp
scriptpreprocessing.cpp
segmentationandanalysisofcells.cpp
semiocr.cpp
simple3dbinpicking.cpp
simple3dstitching.cpp
simpledilateerode.cpp
superresolution.cpp
superresolutioncode.cpp
systemdetection.cpp
tirestringread.cpp
tolerancesoverview.cpp
unwarpmultiviewcylinder.cpp
usdotnumberstr.cpp
utilmatchcolormap.cpp
variousdenoising.cpp
variousstatistics.cpp
visualizefont.cpp
wavelettransformation.cpp

Function Map

- DstContainerOrBufId

- Color

Table:	For specifying a color value
Table:	For specifying a grayscale value to be used with all bands

Compilation information

Synopsis

Clears a buffer, or the components of a container, to a specified color.

Syntax

void MbufClear(

MIL_ID DstContainerOrBufId,	//in
MIL_DOUBLE Color	//in

)

Description

This function clears the specified buffer, or the components of the specified container, to the specified color.

To clear a 16-bit or 32-bit multi-band image buffer to a color value, use MgraClear().

For an image buffer, the clear can be limited to a region of interest (ROI) set using MbufSetRegion().

Using this function with a container is equivalent to using it individually with each component of the container. An error will be generated if the container has a component that cannot be cleared (for example, because it has an ROI defined only in a vector format).

Using this function with a buffer always results in an uncalibrated image. Any previously associated camera calibration context is removed. You can use MgraClear() to clear a buffer while preserving the camera calibration context associated with the empty image.

Note that this function reference has not been updated for a MIL system added during a MIL update. Refer to the MIL system's release note to see which MIL system’s documentation you should use in its place and any possible differences.

Parameters

This function is not supported on the selected boards.

This function reference has not been updated for the selected MIL system. To show the content of this page, choose a second MIL system; refer to the MIL system's release note to see which MIL system’s documentation to choose and any possible differences.

Parameters

DstContainerOrBufId

Specifies the identifier of the buffer or container to clear. If you specify an image buffer, it can have an ROI set using MbufSetRegion(). The ROI must be defined in raster format (M_RASTER or M_VECTOR_AND_RASTER). An error is generated if the ROI is only in vector format (M_VECTOR).

Color

Specifies the color value with which to clear the buffer.

For a 3-band image buffer, this parameter can be set to one of the following color values:

For specifying a color value
Value	Description
M_RGB888( MIL_INT Red, MIL_INT Green, MIL_INT Blue )	Specifies an RGB value used to clear an 8-bit 3-band buffer to an RGB color. Each value (red, green or blue) must not exceed 8 bits. (summarize) Specifies an RGB value used to clear an 8-bit 3-band buffer to an RGB color. (more details...)
		Parameters
		Red Specifies the red component, as a value between 0 and 255.
		Green Specifies the green component, as a value between 0 and 255.
		Blue Specifies the blue component, as a value between 0 and 255.
M_COLOR_BLACK	Specifies the color black.
M_COLOR_BLUE	Specifies the color blue.
M_COLOR_BRIGHT_GRAY	Specifies the color bright gray.
M_COLOR_CYAN	Specifies the color cyan.
M_COLOR_DARK_BLUE	Specifies the color dark blue.
M_COLOR_DARK_CYAN	Specifies the color dark cyan.
M_COLOR_DARK_GREEN	Specifies the color dark green.
M_COLOR_DARK_MAGENTA	Specifies the color dark magenta.
M_COLOR_DARK_RED	Specifies the color dark red.
M_COLOR_DARK_YELLOW	Specifies the color dark yellow.
M_COLOR_GRAY	Specifies the color gray.
M_COLOR_GREEN	Specifies the color green.
M_COLOR_LIGHT_BLUE	Specifies the color light blue.
M_COLOR_LIGHT_GRAY	Specifies the color light gray.
M_COLOR_LIGHT_GREEN	Specifies the color light green.
M_COLOR_LIGHT_WHITE	Specifies the color light white.
M_COLOR_MAGENTA	Specifies the color magenta.
M_COLOR_RED	Specifies the color red.
M_COLOR_WHITE	Specifies the color white.
M_COLOR_YELLOW	Specifies the color yellow.

For a 1-band or 3-band buffer, you can set this parameter to the following grayscale value:

For specifying a grayscale value to be used with all bands
Value	Description
Value	Specifies a grayscale value used to clear the 1-band or multi-band buffer. This value is cast to the buffer type and depth. If the destination buffer is 3-band, this value will be replicated in each band. (summarize) Specifies a grayscale value used to clear the 1-band or multi-band buffer. (more details...)

Compilation information

Header	Include mil.h.
Library	Use mil.lib.
DLL	Requires mil.dll.