Name 

Description 

 

AdoptSubImage 

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. 

 

BlatColor 

 

 

BlatColorAlpha 

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. 

 

BlotImageEx 

 

 

BlotImageSizedEx 

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. 

 

BlotScaledImageSizedEx 

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. 

 

BlotSprite 

output a sprite at its current location 

 

BuildImageFileEx 

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. 

 

DecodeMemoryToImage 

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. 

 

DestroyFont 

Releases all resources for a Font. 

 

FixImagePosition 

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. 

 

FlipImageEx 

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. 

 

GetAlphaValue 

Returns the alpha channel of the color 

 

GetBlueValue 

Returns the blue channel of the color 

 

GetDefaultFont 

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. 

 

GetFontHeight 

Returns the height of a font for purposes of spacing between lines. Characters may render outside of this height. 

 

GetFontRenderData 

This can be used to get the internal description of a font, which the user may then save, and use later to recreate the font the same way. 

 

GetGlobalFonts 

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. 

 

GetGreenValue 

Returns the green channel of the color 

 

GetImageAuxRect 

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. 

 

GetImageSize 

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. 

 

GetImageSurface 

Returns the pointer to the color buffer currently used internal to the image. 

 

GetImageTransformation 

This is function sack::image::GetImageTransformation. 

 

GetMaxStringLengthFont 

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 ); 

 

GetRedValue 

Returns the red channel of the color 

 

GetStringRenderSizeFontEx 

 

 

GetStringSizeFontEx 

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. 

 

ImageRawBMPFile 

direct hack for processing clipboard data... probably does some massaging of the databefore calling DecodeMemoryToImage 

 

InternalRenderFont 

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. 

 

InternalRenderFontFile 

Use a font file to get a font that can be used for outputting characters and strings. 

 

IntersectRectangle 

intersect rectangle, results with the overlapping portion of R1 and R2 into R ... 

 

LoadAllFonts 

internal function to load fonts 

 

LoadFont 

would seem silly to load fonts - but for server implementations the handle received is not the same as the font sent. 

 

LoadImageFileEx 

Extended load image file. This allows specifying a file group to load from. (Groups were added for platforms without support of current working directory). 

 

LoadImageFileFromGroupEx 

Extended load image file. This allows specifying a file group to load from. (Groups were added for platforms without support of current working directory). 

 

MakeAlphaColor 

Create a CDATA color from components. 

 

MakeColor 

Makes a CDATA color from the RGB components. Sets the alpha as 100% opaque. 

 

MakeImageFileEx 

Adds DBG_PASS parameter. Creates an Image with a specified width and height. The image's color is undefined to start. 

 

MakeSpriteImageEx 

create a sprite from an Image 

 

MakeSpriteImageFileEx 

 

 

MakeSubImageEx 

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. 

 

MergeRectangle 

Merges two image rectangles. The resulting rectangle is a rectangle that includes both rectangles. 

 

MoveImage 

Moves an image within a parent image. Top level images and images which have a user color buffer do not move. 

 

OpenFontFile 

This is function sack::image::OpenFontFile. 

 

OrphanSubImage 

Removes a sub-image (child image) from a parent image. The sub image my then be moved to another image with AdoptSubImage. 

 

PutCharacterFont 

background of color 0,0,0 is transparent - alpha component does not matter.... 

 

PutCharacterInvertFont 

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. 

 

PutCharacterVerticalFont 

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. 

 

PutCharacterVerticalInvertFont 

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 

 

PutStringFontEx 

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. 

 

PutStringInvertFontEx 

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. 

 

PutStringInvertVerticalFontEx 

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. 

 

PutStringVerticalFontEx 

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. 

 

RemakeImageEx 

Create or recreate an image using the specified color buffer, and size. All sub-images have their color data reference updated. 

 

RenderFontFileEx 

Renders a font file and returns a Font. The font can then be used in string output functions to images. 

 

RenderScaledFont 

Renders a font with a FRACTION scalar for the X and Y sizes. 

 

RenderScaledFontData 

 

 

RenderScaledFontEx 

 

 

ResizeImageEx 

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 

 

rotate_scaled_sprite 

angle is a fixed scaled integer with 0x1 0000 0000 being the full circle. 

 

rotate_sprite 

output a rotated sprite to destination image, using and angle specified. The angle is represented as 0x1 0000 0000 is 360 degrees 

 

RotateImageAbout 

This is function sack::image::RotateImageAbout. 

 

SetAlphaValue 

Sets the alpha channel in a color value. 

 

SetBlotMethod 

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. 

 

SetBlueValue 

Sets the blue channel in a color value. 

 

SetFontRendererData 

exported for the PSI font chooser to set the data for the font to be retreived later when only the font handle remains. 

 

SetGreenValue 

Sets the green channel in a color value. 

 

SetImageAuxRect 

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. 

 

SetImageBound 

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) 

 

SetImageRotation 

This is function sack::image::SetImageRotation. 

 

SetRedValue 

Sets the red channel in a color value. 

 

SetSavePortion 

provided for display rendering portion to define this method for sprites to use. deliberately out of namespace... please do not move this up. 

 

SetSpriteHotspot 

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. 

 

SetSpritePosition 

This function sets the current location of a sprite. When asked to render, the sprite will draw itself here. 

 

SetStringBehavior 

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. 

 

SyncImage 

This is a function used to synchronize image operations when the image interface is across a message server. 

 

UnloadAllFonts 

internal function to unload fonts 

 

UnloadFont 

Destroys a font, releasing all resources associated with character data and font rendering. 

 

UnmakeImageFileEx 

Releases an image, has extra debug parameters. 

 

UnmakeSprite 

Release a Sprite.