====== calc_AM_GetPixelColour ======

<note important>
This function has been removed from the core API, and is now available via the 'calc.AM.GetPixelColour' zeofunc.
</note>

===== Description =====

Get the [[l3dt:algorithms:cli:land_type:dispcol|display colour]] of a pixel value in an [[l3dt:reference:maps:AM|attributes map]].

===== Function prototype =====

<code>COLORREF CExtAPI::calc_AM_GetPixelColour(AttributesPixel AMpxl);</code>

===== Arguments =====

^ Name ^ Type ^ Comment ^
| AMpxl | [[zeolite:core:types:AttributesPixel]] | A pixel value from an attributes map, the display colour of which is to be determined. |

===== Return value =====

A [[http://msdn.microsoft.com/library/en-us/gdi/colors_9xiq.asp?frame=true|Windows COLORREF]] structure containing the colour of the land type. A value of magenta {R,G,B} = {255, 0, 255} is returned in the case of an error, as this colour is too putrid to use for any other purpose. //When you see magenta, you know something is wrong!//

===== Comments =====

This function is used when displaying the attributes maps on the screen, or when saving it to disk in colour-mapped mode.