GH_MemoryBitmap.Sample Method (Int32, Int32, Color)

GH_MemoryBitmapSample Method (Int32, Int32, Color)

Top level sampling function.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public bool Sample(
	int x,
	int y,
	ref Color col
)
Public Function Sample ( 
	x As Integer,
	y As Integer,
	ByRef col As Color
) As Boolean

Parameters

x
Type: SystemInt32
Unmapped x pixel coordinate.
y
Type: SystemInt32
Unmapped y pixel coordinate.
col
Type: System.DrawingColor
Colour output.

Return Value

Type: Boolean
True on success, false if pixels could not be sampled.
See Also

M:Grasshopper.Kernel.GH_MemoryBitmap.Sample(System.Int32,System.Int32,System.Drawing.Color@)