MgraClear

This function clears the entire specified image buffer to the foreground color of the specified graphics context, or removes all the graphics from the specified graphics list.

Unlike most other functions that modify a MIL object, you can call this function concurrently from multiple threads on the same MIL graphics list (DstImageBufOrListGraId) without using an M_MUTEX object, as long as all the other parameters of the concurrent calls do not also share data.

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 if there is complementary information.

Parameters

This function is not supported on the selected boards.

Parameters

ContextGraId

Specifies the identifier of the graphics context. This parameter must be set to one of the following values:

If you specify a graphics list (DstImageBufOrListGraId), this parameter (ContextGraId) is ignored.

For specifying the graphics context
Value	Description
M_DEFAULT	Specifies that the default graphics context of the current MIL application is used. Note that there is a different default graphics context for each thread. (summarize) Specifies that the default graphics context of the current MIL application is used. (more details...)
MIL graphics context identifier	Specifies a valid graphics context identifier, which you have allocated using MgraAlloc().

DstImageBufOrListGraId

Specifies the identifier of a valid image buffer to clear or the identifier of a valid graphics list to empty. You must have allocated the image buffer or the graphics list using MbufAlloc...() or MgraAllocList(), respectively.

This image buffer must not have a region of interest (ROI) associated with it. Using an image buffer with an ROI will cause an error.

Compilation information

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