Difference between revisions of "ISInterface:GetPixels"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 
===Syntax===
 
===Syntax===
 
+
*bool GetPixels(int X, int Y, unsigned long nRows, unsigned long nColumns, RGBCOLOR **Rows)
 
== Purpose ==
 
== Purpose ==
 
+
To obtain the colors of a lot of pixels
 
== Usage ==
 
== Usage ==
 
=== Parameters ===
 
=== Parameters ===
 
+
*int X
 +
:'''[in]''' X coordinate of the starting pixel
 +
*int Y
 +
:'''[in]''' Y coordinate of the starting pixel
 +
*unsigned long nRows
 +
:'''[in]''' Number of rows
 +
*unsigned long nColumns
 +
:'''[in]''' Number of columns
 +
*RGBCOLOR **Rows
 +
:'''[in]''' Buffer to put the data in (see CPixelMap)
 
=== Return Value ===
 
=== Return Value ===
 
+
*bool
 +
:Returns true on success, false on failure
 
== Examples ==
 
== Examples ==
  
Line 13: Line 23:
 
== See Also ==
 
== See Also ==
 
* [[ISXDK:ISInterface|ISInterface]]
 
* [[ISXDK:ISInterface|ISInterface]]
 
+
* [[ISInterface:GetPixel|GetPixel]]
 
[[Category:ISXDK]]
 
[[Category:ISXDK]]
 
[[Category:ISInterface]]
 
[[Category:ISInterface]]

Revision as of 00:20, 3 September 2005

Syntax

  • bool GetPixels(int X, int Y, unsigned long nRows, unsigned long nColumns, RGBCOLOR **Rows)

Purpose

To obtain the colors of a lot of pixels

Usage

Parameters

  • int X
[in] X coordinate of the starting pixel
  • int Y
[in] Y coordinate of the starting pixel
  • unsigned long nRows
[in] Number of rows
  • unsigned long nColumns
[in] Number of columns
  • RGBCOLOR **Rows
[in] Buffer to put the data in (see CPixelMap)

Return Value

  • bool
Returns true on success, false on failure

Examples

See Also