sack::image Namespace

Deals with images and image processing.

Image is the primary type of this.

Font is a secondary type for putting text on images.

render namespace is contained in image, because without image, there could be no render. see PRENDERER.

Namespace

sack Namespace

Namespaces

Name	Description
interface	This is namespace sack::image::interface.
render	This is namespace sack::image::render.

Topics

Name	Description
Functions	The following table lists functions in this documentation.
Structs, Records, Enums	Global information kept by the specific font subsystem. This was seperated from the guts of Image Global, because PSI Font Picker dialog wants to get information from here (to browse the font cache for instance).
Types	The following table lists types in this documentation.
Variables	The following table lists variables in this documentation.
Macros	The following table lists macros in this documentation.

Functions

	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.

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_LIGHTBROWN	This is macro sack::image::BASE_COLOR_LIGHTBROWN.
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_NICE_ORANGE	This is macro sack::image::BASE_COLOR_NICE_ORANGE.
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.
do_inv_line	now why would we need an inverse line? I don't get it.... anyhow this would draw from the end to the start... basically this accounts for rounding errors on the orward way.
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.
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
GetStringSizeFont
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.
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	A macro to compute the address of a pixel in the color buffer by x, y.
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)
INVERTY_INVERTED	This is macro sack::image::INVERTY_INVERTED.
INVERTY_NON_INVERTED	This is macro sack::image::INVERTY_NON_INVERTED.
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.
LoadImageFileFromGroup	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.
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 sprite 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.
PutCharacter
PutCharacterInvert
PutCharacterInvertVertical
PutCharacterInvertVerticalFont
PutCharacterVertical	Passes default font if not specified.
PutString
PutStringEx
PutStringFont
PutStringInvert
PutStringInvertEx
PutStringInvertFont	The non Ex Version doesn't pass the string length.
PutStringInvertVertical
PutStringInvertVerticalEx
PutStringInvertVerticalFont
PutStringVertical
PutStringVerticalEx
PutStringVerticalFont
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. The resulting font may be scaled from its original size.
RenderFontFile
RenderScaledFont	This is macro sack::image::RenderScaledFont.
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))
SetBlue	Sets the blue channel of a color. Expects a value 0-255.
SetGreen	Sets the green channel of a color. Expects a value 0-255.
SetRed	Sets the red channel of a color. Expects a value 0-255.
UnmakeImageFile	Releases an image, has extra debug parameters.

Structs, Records, Enums

	Name	Description
	AlphaModifier	Transparency parameter definition 0 : no transparency - completely opaque 1 (TRUE): 0 colors (absolute transparency) only 2-255 : 0 color transparent, plus transparency factor applied to all 2 - mostly almost completely transparent 255 not transparent (opaque) 257-511 : alpha transparency in pixel plus transparency value - 256 0 pixels will be transparent 257 - slightly more opaquen than the original 511 - image totally opaque - alpha will be totally overriden no addition 511 nearly completely transparent 512-767 ; the low byte of this is subtracted from the alpha of the image ; this allows images... more
	alt_size_file_tag	Describes an alternate file location for this font. During the building of the cache, the same fonts may exist on a system multiple times.
	blot_methods	Definitions of symbols to pass to SetBlotMethod to specify optimization method.
	BlotOperation	specify the method that pixels are copied from one image to another
	boundry_rectangle_tag	Defines the coordinates of a rectangle. Pointer to an image rectangle.
	color_byte_index	byte index values for colors on the video buffer...
	data_transfer_state_tag	A definition of a block structure to transport font and image data across message queues. Type of buffer used to transfer data across message queues.
	file_size_tag	GetGlobalFont()->pFontCache
	font_data_tag	This is the internal structure used to define the font cache, and data structures used to track renderings of fonts. Structures include desired size of the font in pixels. This data structure can be requested from the image library and can be used to recreate the font again in the future. This font came from a font choice dialog and includes all the IDs of the options selected.
	font_entry_tag
	font_global_tag	Global information kept by the specific font subsystem. This was seperated from the guts of Image Global, because PSI Font Picker dialog wants to get information from here (to browse the font cache for instance).
	font_style_t	describes a style of a font family.
	FontMagicIdentifiers	These are symbols used for 'magic' in PFONTDATA and PRENDER_FONTDATA. Magic values to determine if a structure is a PFONTDATA or a PRENDER_FONTDATA.
	image_rotation_flags	These flags are used in SetImageRotation and RotateImageAbout functions - these are part of the 3D driver interface extension. They allow for controlling how the rotation is performed.
	ImageFile_tag	define _DRAWPOINT_X 0 define _DRAWPOINT_Y 1
	ImageFlags	Flags which may be combined in Image.flags
	render_font_data_tag	This is used to define the data usable to recreate a font being rendered right now. This is the data that would result from calling RenderFontFile, and would be used in future uses of RenderScaledFontData.
	simple_font_tag	#endif at some point, it may be VERY useful to have this structure also have a public member.
	size_tag	Describes size information about a font family, style, and the file instance specified.
	sprite_tag	A simple wrapper to add dynamic changing position and orientation to an image. Sprites can be output at any angle.
	string_behavior
	ALT_SIZE_FILE	Describes an alternate file location for this font. During the building of the cache, the same fonts may exist on a system multiple times.
	DataState	A definition of a block structure to transport font and image data across message queues. Type of buffer used to transfer data across message queues.
	FONT_ENTRY
	FONT_GLOBAL	Global information kept by the specific font subsystem. This was seperated from the guts of Image Global, because PSI Font Picker dialog wants to get information from here (to browse the font cache for instance).
	FONT_STYLE	describes a style of a font family.
	FontData	#endif at some point, it may be VERY useful to have this structure also have a public member.
	IMAGE_RECTANGLE	Defines the coordinates of a rectangle. Pointer to an image rectangle.
	P_IMAGE_RECTANGLE	Defines the coordinates of a rectangle. Pointer to an image rectangle.
	PALT_SIZE_FILE	Describes an alternate file location for this font. During the building of the cache, the same fonts may exist on a system multiple times.
	PFONT_ENTRY
	PFONT_STYLE	describes a style of a font family.
	PSIZE_FILE	GetGlobalFont()->pFontCache
	PSIZES	Describes size information about a font family, style, and the file instance specified.
	RENDER_FONTDATA	This is used to define the data usable to recreate a font being rendered right now. This is the data that would result from calling RenderFontFile, and would be used in future uses of RenderScaledFontData.
	SIZE_FILE	GetGlobalFont()->pFontCache
	SIZES	Describes size information about a font family, style, and the file instance specified.

Types

Name	Description
CDATA	color data raw...
COLOR	a 4 byte array of color (not really used, we mostly went with CDATA and PCDATA instead of COLOR and PCOLOR
COLOR_CHANNEL	IMAGE_LIBRARY_SOURCE a definition for a single color channel - for function replacements for ___Val macros
fixed	A fixed point decimal number (for freetype font rendering)
Font	Contains information about a font for drawing and rendering from a font file.
FONTDATA	defines FONTDATA for internal usage.
Image	One of the two primary types that the image library works with.
IMAGE_COORDINATE	#ifndef IMAGE_STRUCTURE_DEFINED #define IMAGE_STRUCTURE_DEFINED consider minimal size - +/- 32000 should be enough for display purposes. print... well that's another matter.
IMAGE_EXTENT	An unsigned value coordinate pair to track the size of images.
IMAGE_POINT	An array of 2 IMAGE_COORDINATES - [0] = x, [1] = y
IMAGE_SIZE_COORDINATE	Represents the width and height of an image (unsigned values)
ImageFile	The basic structure. This is referenced by applications as 'Image' This is the primary type that the image library works with. This is the internal definition. This is a actual data content, Image is (ImageFile *).
P_IMAGE_EXTENT	Pointer to a IMAGE_EXTENT
P_IMAGE_POINT	Pointer to an IMAGE_POINT
PCDATA	pointer to an array of 32 bit colors
PCOLOR	A Pointer to COLOR. Probably an array of color (a block of pixels for instance)
PFONTDATA	types of data which may result...
PRENDER_FONTDATA	Information to render a font from a file to memory.
PSPRITE	pointer to a sprite type.
PSPRITE_METHOD	pointer to a structure defining a sprite draw method this should be defined in render namespace...
SPRITE	A Sprite type. Adds position and rotation and motion factors to an image. Hooks into the render system to get an update to draw on a temporary layer after the base rendering is done.

Variables

Name	Description
ColorAverage	This routine can be used to generically scale to any point between two colors.
do_hline	This is a function pointer that references a function to do optimized horizontal lines. The function pointer is updated when SetBlotMethod() is called.
do_hlineAlpha	This is a function pointer that references a function to do optimized horizontal lines with alpha blending. The function pointer is updated when SetBlotMethod() is called.
do_line	d is color data...
do_lineAlpha	d is color data...
do_lineExV	routine which iterates through the points along a lone from x,y to xto,yto, calling a user function at each point.
do_vline	This is a function pointer that references a function to do optimized vertical lines. The function pointer is updated when SetBlotMethod() is called.
do_vlineAlpha	This is a function pointer that references a function to do optimized vertical lines with alpha blending. The function pointer is updated when SetBlotMethod() is called.
getpixel	A function pointer to the function which gets a pixel from an image at a specified x, y coordinate.
plot	Your basic PLOT functions (Image.C, plotasm.asm) A function pointer to the function which sets a pixel in an image at a specified x, y coordinate.
plotalpha	A function pointer to the function which sets a pixel in an image at a specified x, y coordinate.

Links

sack Namespace, Legend, Namespaces, Topics, Functions, Macros, Structs, Records, Enums, Types, Variables

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.

Contents | Index | Reference | Home

What do you think about this topic? Send feedback!