Sack Library Documentation
ContentsIndexReferenceHome
PreviousUpNext
image_interface_tag Data Members

The data members of the image_interface_tag class are listed here.

 
Name 
Description 
 
Get the global font data structure. This is an internal structure, and it's definition may not be exported. Currently the definition is in documentation. 
 
After a data transfer decode the information as a font. 
 
Adds an image as a sub-image of another image. The image being added as a sub image must not already have a parent. Sub-images are like views into the parent, and share the same pixel buffer that the parent has. 
 
 
 
 
 
Blat is the sound a trumpet makes when it spews forth noise... so Blat color is just fill a rectangle with a color, quickly. Apply alpha transparency of the color specified. 
 
 
 
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. 
 
output a sprite at its current location 
 
 
 
 
 
Decodes a block of memory into an image. This is used internally so, LoadImageFile() opens the file and reads it into a buffer, which it then passes to DecodeMemoryToImage(). Images stored in custom user structures may be passed for decoding also. 
 
 
 
Releases all resources for a Font
 
reset clip rectangle to the full image (subimage part ) Some operations (move, resize) will also reset the bound rect, this must be re-set afterwards. ALSO - one SHOULD be nice and reset the rectangle when done, otherwise other people may not have checked this. 
 
This is GetAlphaValue, a member of class image_interface_tag. 
 
This is GetBlueValue, a member of class image_interface_tag. 
 
Returns the correct Font pointer to the default font. In all font functions, NULL may be used as the font, and this is the font that will be used. 
 
Returns the height of a font for purposes of spacing between lines. Characters may render outside of this height. 
 
 
 
Get the global font data structure. This is an internal structure, and it's definition may not be exported. Currently the definition is in documentation. 
 
This is GetGreenValue, a member of class image_interface_tag. 
 
User applications may use an aux rect attatched to an image. The 'Display' render library used this itself however, making this mostly an internal feature. 
 
Used as a proper accessor method to get an image's width and height. Decided to allow the image structure to be mostly public, so the first 4 members are the images x,y, width and height, and are immediately accessable by the Image pointer. 
 
Returns the pointer to the color buffer currently used internal to the image
 
This is GetImageTransformation, a member of class image_interface_tag. 
 
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 ); 
 
This is GetRedValue, a member of class image_interface_tag. 
 
 
 
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. 
 
Creates a font based on indexes from the internal font cache. This is used by the FontPicker dialog to choose a font. The data the dialog used to render the font is available to the application, and may be passed back for rendering a font without knowing specifically what the values mean. 
 
Use a font file to get a font that can be used for outputting characters and strings. 
 
intersect rectangle, results with the overlapping portion of R1 and R2 into R ... 
 
would seem silly to load fonts - but for server implementations the handle received is not the same as the font sent. 
 
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 LoadImageFileFromGroupEx, a member of class image_interface_tag. 
 
This is MakeAlphaColor, a member of class image_interface_tag. 
 
This is MakeColor, a member of class image_interface_tag. 
 
Adds DBG_PASS parameter. Creates an Image with a specified width and height. The image's color is undefined to start. 
 
create a sprite 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. 
 
Merges two image rectangles. The resulting rectangle is a rectangle that includes both rectangles. 
 
Moves an image within a parent image. Top level images and images which have a user color buffer do not move. 
 
Removes a sub-image (child image) from a parent image. The sub image my then be moved to another image with AdoptSubImage
 
background of color 0,0,0 is transparent - alpha component does not matter.... 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Create or recreate an image using the specified color buffer, and size. All sub-images have their color data reference updated. 
 
 
 
This is RenderScaledFont, a member of class image_interface_tag. 
 
Recreates a Font based on saved FontData. The resulting font may be scaled from its original size. 
 
This is RenderScaledFontEx, a member of class image_interface_tag. 
 
Change the size of an image, reallocating the color buffer as necessary.
Parameters
Remarks
If the image is a sub image (located within a parent), the subimage view on the parent image is updated to the new width and height. The color buffer remains the parent's buffer.
If the image is a parent, a new buffer is allocated. If the previous buffer was specified by the user in RemakeImage, that buffer is not freed, but a new buffer is still created.

Bugs
If the image is a parent image, the child images are not updated to the... more 
 
angle is a fixed scaled integer with 0x1 0000 0000 being the full circle. 
 
output a rotated sprite to destination image, using and angle specified. The angle is represented as 0x1 0000 0000 is 360 degrees 
 
This is RotateImageAbout, a member of class image_interface_tag. 
 
This is SetAlphaValue, a member of class image_interface_tag. 
 
Specify the optimized code to draw with. There are 3 levels, C - routines coded in C, ASM - assembly optimization (32bit NASM), MMX assembly but taking advantage of MMX features. 
 
This is SetBlueValue, a member of class image_interface_tag. 
 
 
 
This is SetGreenValue, a member of class image_interface_tag. 
 
User applications may use an aux rect attatched to an image. The 'Display' render library used this itself however, making this mostly an internal feature. 
 
Sets the active image rectangle to the bounding rectangle specified. This can be used to limit artificially drawing onto an image. (It is easier to track to create a subimage in the location to draw instead of masking with a bound rect, which has problems restoring back to initial conditions) 
 
This is SetImageRotation, a member of class image_interface_tag. 
 
This is SetRedValue, a member of class image_interface_tag. 
 
Sets the point on a sprite which is the 'hotspot' the hotspot is the point that is drawn at the specified coordinate when outputting a sprite. 
 
This function sets the current location of a sprite. When asked to render, the sprite will draw itself here. 
 
library global changes. string behavior cannot be tracked per image. string behavior should, for all strings, be the same usage for an application... so behavior is associated with the particular stream and/or image family. does not modify character handling behavior - only strings. 
 
This is a function used to synchronize image operations when the image interface is across a message server. 
 
Destroys a font, releasing all resources associated with character data and font rendering. 
 
Releases an image, has extra debug parameters. 
 
Releases an image, has extra debug parameters. 
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at support@toolsfactory.com.
Copyright (c) 2000+. All rights reserved.
What do you think about this topic? Send feedback!