MgraBackColor

See also

User Guide:

Writing text

Reference:

MgraAlloc MgraControl

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

3dprofilemetrology.cpp
codedetect.cpp
codetrain.cpp
dotspacing.cpp
fixturedcoderead.cpp
mcal.cpp
mcal.cs
mcal.vb
mcode.cpp
mcode.cs
mcode.vb
specularreflectionreduction.cpp
variouscodereadings.cpp

Function Map

Table:

For specifying the 2D graphics context

- BackgroundColor

Table:

For the background color

Compilation information

Synopsis

Sets the background color of the 2D graphics context.

Syntax

void MgraBackColor(

MIL_ID ContextGraId,	//in
MIL_DOUBLE BackgroundColor	//in

)

Description

This function sets the background color of the specified 2D graphics context.

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

ContextGraId

Specifies the identifier of the 2D graphics context in which to set the background color. This parameter must be set to one of the following values:

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

BackgroundColor INQ

Specifies the background color of a specified 2D graphics context. This parameter must be set to one of the following values:

For the background color
Value	Description
M_RGB888( MIL_INT Red, MIL_INT Green, MIL_INT Blue )	Specifies an RGB value when using the 2D graphics context to draw in an 8-bit, 3-band buffer. The red, green, and blue values must be values between 0 and 255, inclusive. When drawing in a 16-bit or 32-bit multi-band buffer, the components of the RGB value are cast to the type of the destination buffer's bands. To specify a 16-bit or 32-bit color component, use MgraControl() with M_BACKCOLOR combined with the appropriate constant (M_RED, M_GREEN, or M_BLUE). (summarize) Specifies an RGB value when using the 2D graphics context to draw in an 8-bit, 3-band buffer. (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.
Value >= 0	Specifies a grayscale value. When drawing in a 1-band buffer, the grayscale value is cast to the type of the destination buffer. When drawing in a multi-band buffer, the grayscale value is cast to the type of the destination buffer's bands. This value will be replicated in each band. Note that a grayscale value can be any integer or floating-point number. If the given value exceeds the range of the possible values that can be stored in each band of the destination buffer, the least significant bits of the value are used. (summarize) Specifies a grayscale value. (more details...)

Compilation information

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