MbufClear

User Guide:

Annotating the displayed image non-destructively Calibration propagation Generating fully corrected depth and intensity maps Graphics context

Reference:

MbufAlloc2d MbufInquire MbufSetRegion MgraClear

Available in MIL-Lite

Available in MIL

Available on Windows

Available on Linux

Partially supported on:

Matrox GPU processing driver

Fully supported on:

Host system

Matrox CronosPlus

Matrox GigE Vision driver

Matrox IEEE 1394 IIDC driver

Matrox Iris GT

Matrox Morphis

Matrox Morphis QxT

Matrox Orion HD

Matrox Radient eCL

Matrox Radient eV-CXP

Matrox Solios eA/XA

Matrox Solios ecl/xcl/ev-cl

Matrox USB3 Vision driver (requires Update 19)

Matrox Vio

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

Available on Matrox Supersight

Function Map

Syntax

Description

Parameters

- DstBufId

- Color

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

Compilation information

3dmodelheightdefect.cpp
3dplanefit.cpp
bestplanefitter.cpp
binarybasedcircledetection.cpp
blisterpackinspection.cpp
blobmerge.cpp
bottlecapinspection.cpp
calibrationfromlist.cpp
cameraevents.cpp
cameralasercalibration.cpp
cameraonrobotarmcalibration.cpp
caninspection.cpp
chromasens3dpixa.cpp
chunkmode.cpp
codegrading.cpp
colorbasedproductidentification.cpp
colorrelativecalibration.cpp
cookiedetection.cpp
defectdetectionexample.cpp
defectdetectionprocfunc.cpp
defectdetectionprocfunc_capandcontent.cpp
depthdatamgr.cpp
dmilmdigprocesssharedmemory.cpp
dmilmultisystem.cpp
dmilobjecttracking.cpp
dotspacing.cpp
exampleinterface.cpp
examplemanager.cpp
examplemanagerfor3d.cpp
fdkaddconstantmain.cpp
fdklutmapmain.cpp
fdkoffsetgainlutmapmain.cpp
fdkoffsetgainmain.cpp
fdkoffsetgainminmaxmain.cpp
findimageorientation.cpp
flatfieldcorrection.cpp
foodinspection_cereal.cpp
foodinspection_mango.cpp
foodinspectioncereal.cpp
foodinspectionmango.cpp
form1.cs
form1.vb
histogramdisplay.cpp
histogramequalizeadaptive.cpp
interactivebayer.cpp
kinect.cpp
m3dmap.cpp
m3dmap.cs
m3dmap.vb
mapptrace.cpp
mapptrace.cs
mapptrace.vb
matroxgatoreye.cpp
mbufcolor.cpp
mbufcolor.cs
mbufcolor.vb
mcol.cpp
mcol.cs
mcol.vb
mdigautofocus.cpp
mdigautofocus.cs
mdigautofocus.vb
mdiggrabmultiple.cpp
mdiggrabsequence.cpp
mdiggrabsequence.cs
mdiggrabsequence.vb
mdigprocess.cpp
mdigprocess.cs
mdigprocess.vb
mdigprocess16vd.cpp
mdigprocessmultiple.cpp
mdispgtkview.cpp
mdispmfcdoc.cpp
mdispoverlay.cpp
mdispoverlay.cs
mdispoverlay.vb
mdispqtview.cpp
mdispwindow.cpp
mdispwindowgtk.cpp
mdispwindowqt.cpp
mechanicalpartscan.cpp
microsoftkinect.cpp
milapplication.cs
milapplication.vb
milgige.cpp
mimbinarizeadaptive.cpp
mimdeinterlace.cpp
mimdeinterlace.cs
mimdeinterlace.vb
mimfft.cpp
mimfft.cs
mimfft.vb
mimlocatepeak1d.cpp
mimlocatepeak1d.cs
mimlocatepeak1d.vb
mimwarp.cpp
mimwarp.cs
mimwarp.vb
mocr.cpp
mocr.cs
mocr.vb
morphischannelswitchingdlg.cpp
morphology.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
packetdelay.cpp
pcbmodelmatching.cpp
pfocus.cpp
processingfpga.cpp
productidentificationoasis.cpp
profiledisplay.cpp
regionmanager.cpp
scriptpreprocessing.cpp
segmentationandanalysisofcells.cpp
semiocr.cpp
sickrangerc.cpp
sickrangere.cpp
simpledilateerode.cpp
superresolution.cpp
tirestringread.cpp
utilmatchcolormap.cpp
variousdenoising.cpp
viofeaturesdemo.cpp
vioplayback.cpp
wavelettransformation.cpp

MbufChildMove

MbufClearCond

Synopsis

Clears a buffer to a specified color.

Syntax

void MbufClear(

MIL_ID DstBufId,	//in
MIL_DOUBLE Color	//in

)

Description

This function clears the specified buffer 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().

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

DstBufId

Specifies the identifier of the buffer 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).

[Matrox GPU processing driver]

If you specify an image buffer, it must be an unsigned 8- or 16-bit monochrome buffer, a packed BGR32 buffer, or a packed binary buffer.

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.