GetDibPixelVariant (ImageKit Control/ Effect Method)

This method retrieves the RGB values and palette number of the specified pixel in the Device Independent Bitmap (DIB).

[Visual Basic] [ Boolean = ]imagekitcontrolname.Effect.GetDibPixelVariant(DibNo As Integer, x As Long, y As Long, PalNo As Variant, Red As Variant, Green As Variant, Blue As Variant)

[VB.NET] [ Boolean = ]imagekitcontrolname.Effect.GetDibPixelVariant(DibNo As Short, x As Integer, y As Integer, ByRef PalNo As Object, ByRef Red As Object, ByRef Green As Object, ByRef Blue As Object)

[C#.NET] [ bool = ]imagekitcontrolname.Effect.GetDibPixelVariant(short DibNo, int x, int y, ref object PalNo, ref object Red, ref object Green, ref object Blue)

Parameters

Name	Explanation
DibNo	The identification number of the DIB as retrieved from the StartDibAccessVariant method.
x, y	The x,y coordinates of the specified pixel
PalNo	The palette number of the specified pixel
Red	The red component of the RGB value of the specified pixel
Green	The green component of the RGB value of the specified pixel
Blue	The blue component of the RGB value of the specified pixel

Return Value

Returns True (nonzero) if successful, otherwise returns False (0).

Explanation

The GetDibPixelVariant method retrieves the RGB values and palette number of the specified pixel in the Device Independent Bitmap (DIB). This method is equivalent to the GetDibPixel method but can be used in scripting languages that require variant types. The DibNo parameter value must be the same as that retrieved from the StartDibAccessVariant method. For 1, 4, and 8 bit images, the applicable values are set in the PalNo parameter. For 16, 24, and 32 bit images, the applicable values are set in the Red, Green, and Blue parameters

To access the DIB and manipulate pixel data, you must use the following methods as a group:
StartDibAccessVariant
|
GetDibPixelVariant, SetDibPixelVariant
|
EndDibAccessVariant