Documentation Project 1
ContentsIndexHome
PreviousUpNext
Macros

The following table lists macros in this documentation.

Name 
Description 
Build a color with alpha specified. 
Get the alpha value of a color. This is a 0-255 unsigned byte. 
This is a macro to cure a 64bit warning in visual studio. 
common color definitions.... 
An opaque normal blue. 
An opaque BROWN. Brown is dark yellow... so this might be more like a gold sort of color instead. 
An opaque cyan - kind of a light sky like blue. 
An opaque darker grey (gray?). 
An opaque Green. 
An opaque a bight or light color blue. 
An opaque a lighter, more bight cyan color. 
An opaque lighter, brighter green color. 
An opaque normal grey (gray?). 
An opaque Lighter pink sort of red-blue color. 
An opaque bright red. 
An opaque normal Magenta - a lighter, more red purple. 
An opaque normal orange. 
An opaque normal purple (magenta). 
An opaque red. 
An opaque White. 
An opaque bright yellow. 
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. 
Copy one image to another at the specified coordinate in the destination. 
Copy one image to another at the specified coordinate in the destination. Scale RGB channels to specified colors. 
Copy one image to another at the specified coordinate in the destination. Scale RGB channels to specified colors. 
Copy one image to another at the specified coordinate in the destination. Shade the image on copy with a color. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
Get the blue value of a color. This is a 0-255 unsigned byte. 
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. 
 
 
A macro to create a solid color from R G B coordinates. 
Macro to build function pointer entries in the image interface. 
now why would we need an inverse line? I don't get it.... 
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. 
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. 
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 ); 
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. 
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 ); 
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. 
Return a CDATA that is meant for output to OpenGL. 
Get the green value of a color. This is a 0-255 unsigned byte. 
A macro for accessing vertical (Y) information of an IMAGE_POINT
A macro for accessing vertical (Y) information of an IMAGE_POINT
Defines a pointer member of the interface structure. 
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). 
This is macro sack::image::IMG_ADDRESS. 
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) 
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. 
This is a 4 character constant 'FONT' indicating a more general font structure. 
this is a 4 character constant 'PICK' indicating the font data is a PickFont structure. 
Adds DBG_PASS parameter. Creates an Image with a specified width and height. The image's color is undefined to start. 
Create a PSPRITE from an Image
 
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. 
Method to define automatic name translation from standard names Like BlatColorAlphaEx to the interface the user has specified to be using. For function pointers. 
Method to define automatic name translation from standard names Like BlatColorAlphaEx to the interface the user has specified to be using. 
background of color 0,0,0 is transparent - alpha component does not matter.... 
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. 
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 
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 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
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. 
Get the red value of a color. This is a 0-255 unsigned byte. 
Create or recreate an image using the specified color buffer, and size. All sub-images have their color data reference updated. 
Recreates a Font based on saved FontData
Renders a font file and returns a Font. The font can then be used in string output functions to images. 
Create or recreate an image using the specified color buffer, and size. All sub-images have their color data reference updated. 
Sets the alpha part of a color. (0-255 value, 0 being transparent, and 255 solid(opaque)) 
Sets the green channel of a color. Expects a value 0-255. 
Destroys an image. Does not automatically destroy child images created on the image
Copyright (c) 2010. All rights reserved.
What do you think about this topic? Send feedback!