Macros

Name	Description
AColor	Build a color with alpha specified.
AlphaVal	Get the alpha value of a color. This is a 0-255 unsigned byte.
AND_FF	This is a macro to cure a 64bit warning in visual studio.
BASE_COLOR_BLACK	common color definitions....
BASE_COLOR_BLUE	An opaque normal blue.
BASE_COLOR_BROWN	An opaque BROWN. Brown is dark yellow... so this might be more like a gold sort of color instead.
BASE_COLOR_CYAN	An opaque cyan - kind of a light sky like blue.
BASE_COLOR_DARKGREY	An opaque darker grey (gray?).
BASE_COLOR_GREEN	An opaque Green.
BASE_COLOR_LIGHTBLUE	An opaque a bight or light color blue.
BASE_COLOR_LIGHTCYAN	An opaque a lighter, more bight cyan color.
BASE_COLOR_LIGHTGREEN	An opaque lighter, brighter green color.
BASE_COLOR_LIGHTGREY	An opaque normal grey (gray?).
BASE_COLOR_LIGHTMAGENTA	An opaque Lighter pink sort of red-blue color.
BASE_COLOR_LIGHTRED	An opaque bright red.
BASE_COLOR_MAGENTA	An opaque normal Magenta - a lighter, more red purple.
BASE_COLOR_ORANGE	An opaque normal orange.
BASE_COLOR_PURPLE	An opaque normal purple (magenta).
BASE_COLOR_RED	An opaque red.
BASE_COLOR_WHITE	An opaque White.
BASE_COLOR_YELLOW	An opaque bright yellow.
BlotImage	Copy one image to another. Copies the source from 0,0 to the destination 0,0 of the minimum width and height of the smaller of the source or destination.
BlotImageAlpha	Copy one image to another at the specified coordinate in the destination.
BlotImageMultiShaded	Copy one image to another at the specified coordinate in the destination. Scale RGB channels to specified colors.
BlotImageMultiShadedSized	Copy one image to another at the specified coordinate in the destination. Scale RGB channels to specified colors.
BlotImageShaded	Copy one image to another at the specified coordinate in the destination. Shade the image on copy with a color.
BlotImageShadedSized	Copies an image from one image onto another. The copy is done directly and no scaling is applied. If a width or height larget than the image to copy is specified, only the amount of the image that is valid is copied.
BlotImageSized	Copies an image from one image onto another. The copy is done directly and no scaling is applied. If a width or height larget than the image to copy is specified, only the amount of the image that is valid is copied.
BlotImageSizedAlpha	Copies an image from one image onto another. The copy is done directly and no scaling is applied. If a width or height larget than the image to copy is specified, only the amount of the image that is valid is copied.
BlotImageSizedTo	Copies an image from one image onto another. The copy is done directly and no scaling is applied. If a width or height larget than the image to copy is specified, only the amount of the image that is valid is copied.
BlotScaledImage	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageAlpha	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageMultiShaded	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageMultiShadedAlpha	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageShaded	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageShadedAlpha	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageSized	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageSizedMultiShaded	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageSizedTo	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageSizedToAlpha	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageSizedToMultiShaded	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageSizedToMultiShadedAlpha	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageSizedToShaded	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageSizedToShadedAlpha	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlotScaledImageTo	Copies some or all of an image to a destination image of specified width and height. This does linear interpolation scaling. There are simple forms of this function as macros, since commonly you want to output the entire image, a macro which automatically sets (0,0),(width,height) as the source parameters to output the whole image exists.
BlueVal	Get the blue value of a color. This is a 0-255 unsigned byte.
BuildImageFile	Creates an image from user defined parts. The buffer used is from the user. This was used by the video library, but RemakeImage accomplishes this also.
ClearImage
ClearImageTo
Color	A macro to create a solid color from R G B coordinates.
DIMAGE_PROC_PTR	Macro to build function pointer entries in the image interface.
do_inv_line	now why would we need an inverse line? I don't get it....
DropImageInterface	When done with an image interface, the application should drop it. This disconnects message pipes etc, when the image library is mounted across a pipe service.
FlipImage	This function flips an image top to bottom. This if for building windows compatible images. Internally images are kept in platform-native direction. If an image is created from another source, this might be a method to flip the image top-to-bottom if required.
GetMaxStringLength	32 (PutMenuStringFontEx) ( Image pImage, S_32 x, S_32 y, CDATA color, CDATA background, CTEXTSTR pc, _32 nLen, Font font ); 32 (PutCStringFontEx) ( Image pImage, S_32 x, S_32 y, CDATA color, CDATA background, CTEXTSTR pc, _32 nLen, Font font );
GetStringSize	Returns the approximate rectangle that would be used for a string. It only counts using the line measurement. Newlines in strings count to wrap text to subsequent lines and start recounting the width, returning the maximum length of string horizontally.
GetStringSizeEx	IMG_PROC _32 GetMenuStringSizeFontEx( CTEXTSTR string, _32 len, _32 width, _32 height, PFONT font ); IMG_PROC _32 GetMenuStringSizeFont( CTEXTSTR string, _32 width, _32 height, PFONT font );
GetStringSizeFont	Returns the approximate rectangle that would be used for a string. It only counts using the line measurement. Newlines in strings count to wrap text to subsequent lines and start recounting the width, returning the maximum length of string horizontally.
GLColor	Return a CDATA that is meant for output to OpenGL.
GreenVal	Get the green value of a color. This is a 0-255 unsigned byte.
IMAGE_POINT_H	A macro for accessing vertical (Y) information of an IMAGE_POINT.
IMAGE_POINT_V	A macro for accessing vertical (Y) information of an IMAGE_POINT.
IMAGE_PROC_PTR	Defines a pointer member of the interface structure.
ImageData	the image at exactly this position and size is the one being referenced, the actual size and position may vary depending on use (a sub-image outside the boundry of its parent).
IMG_ADDRESS	This is macro sack::image::IMG_ADDRESS.
INVERTY	This is a macro is used when image data is inverted on a platform. (Windows images, the first row of data is the bottom of the image, all Image operations are specified from the top-left as 0,0)
LoadImageFile	Load an image file. Today we support PNG, JPG, GIF, BMP. Tomorrow consider tapping into that FreeImage project on sourceforge, that combines all readers into one.
MAGIC_PICK_FONT	This is a 4 character constant 'FONT' indicating a more general font structure.
MAGIC_RENDER_FONT	this is a 4 character constant 'PICK' indicating the font data is a PickFont structure.
MakeImageFile	Adds DBG_PASS parameter. Creates an Image with a specified width and height. The image's color is undefined to start.
MakeSpriteImage	Create a PSPRITE from an Image.
MakeSpriteImageFile
MakeSubImage	Creates a sub image region on an image. Sub-images may be used like any other image. There are two uses for this sort of thing. OH, the sub image shares the exact data of the parent image, and is not a copy.
PPROC_ALIAS	Method to define automatic name translation from standard names Like BlatColorAlphaEx to the interface the user has specified to be using. For function pointers.
PROC_ALIAS	Method to define automatic name translation from standard names Like BlatColorAlphaEx to the interface the user has specified to be using.
PutCharacter	background of color 0,0,0 is transparent - alpha component does not matter....
PutCharacterInvert	Outputs a string in the specified font, from the specified point, text is drawn from the point to the left, with the characters aligned with the top to the left; it goes up from the point. the point becomes the bottom left of the rectangle output.
PutCharacterInvertVertical	Outputs a character in the specified font, from the specified point, text is drawn from the point up, with the characters aligned with the top to the left; it goes up from the point. the point becomes the bottom left of the rectangle output. Parameters
PutCharacterInvertVerticalFont	Outputs a character in the specified font, from the specified point, text is drawn from the point up, with the characters aligned with the top to the left; it goes up from the point. the point becomes the bottom left of the rectangle output. Parameters
PutCharacterVertical	Outputs a string in the specified font, from the specified point, text is drawn from the point up, with the characters aligned with the top to the left; it goes up from the point. the point becomes the bottom left of the rectangle output.
PutString	Outputs a string in the specified font, from the specified point, text is drawn right side up and godes from left to right. The point becomes the top left of the rectangle output.
PutStringEx	Outputs a string in the specified font, from the specified point, text is drawn right side up and godes from left to right. The point becomes the top left of the rectangle output.
PutStringFont	Outputs a string in the specified font, from the specified point, text is drawn right side up and godes from left to right. The point becomes the top left of the rectangle output.
PutStringInvert	Outputs a string in the specified font, from the specified point, text is drawn upside down, and goes to the left from the point. the point becomes the bottom right of the rectangle output.
PutStringInvertEx	Outputs a string in the specified font, from the specified point, text is drawn upside down, and goes to the left from the point. the point becomes the bottom right of the rectangle output.
PutStringInvertFont	Outputs a string in the specified font, from the specified point, text is drawn upside down, and goes to the left from the point. the point becomes the bottom right of the rectangle output.
PutStringInvertVertical	Outputs a string in the specified font, from the specified point, text is drawn from the point up, with the characters aligned with the top to the left; it goes up from the point. the point becomes the bottom left of the rectangle output.
PutStringInvertVerticalEx	Outputs a string in the specified font, from the specified point, text is drawn from the point up, with the characters aligned with the top to the left; it goes up from the point. the point becomes the bottom left of the rectangle output.
PutStringInvertVerticalFont	Outputs a string in the specified font, from the specified point, text is drawn from the point up, with the characters aligned with the top to the left; it goes up from the point. the point becomes the bottom left of the rectangle output.
PutStringVertical	Outputs a string in the specified font, from the specified point, text is drawn from the point down, with the characters aligned with the top to the right; it goes down from the point. the point becomes the top right of the rectangle output.
PutStringVerticalEx	Outputs a string in the specified font, from the specified point, text is drawn from the point down, with the characters aligned with the top to the right; it goes down from the point. the point becomes the top right of the rectangle output.
PutStringVerticalFont	Outputs a string in the specified font, from the specified point, text is drawn from the point down, with the characters aligned with the top to the right; it goes down from the point. the point becomes the top right of the rectangle output.
RedVal	Get the red value of a color. This is a 0-255 unsigned byte.
RemakeImage	Create or recreate an image using the specified color buffer, and size. All sub-images have their color data reference updated.
RenderFontData	Recreates a Font based on saved FontData.
RenderFontFile	Renders a font file and returns a Font. The font can then be used in string output functions to images.
ResizeImage	Create or recreate an image using the specified color buffer, and size. All sub-images have their color data reference updated.
SetAlpha	Sets the alpha part of a color. (0-255 value, 0 being transparent, and 255 solid(opaque))
SetGreen	Sets the green channel of a color. Expects a value 0-255.
UnmakeImageFile	Destroys an image. Does not automatically destroy child images created on the image.

Contents | Index | Home