2000-07-02 03:27:32 +02:00
|
|
|
/***************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* ftoutln.h */
|
|
|
|
|
/* */
|
2000-07-14 08:16:47 +02:00
|
|
|
/* Support for the FT_Outline type used to store glyph shapes of */
|
|
|
|
|
/* most scalable font formats (specification). */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
|
|
|
|
/* Copyright 1996-2000 by */
|
|
|
|
|
/* David Turner, Robert Wilhelm, and Werner Lemberg. */
|
|
|
|
|
/* */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* This file is part of the FreeType project, and may only be used, */
|
|
|
|
|
/* modified, and distributed under the terms of the FreeType project */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* license, LICENSE.TXT. By continuing to use, modify, or distribute */
|
|
|
|
|
/* this file you indicate that you have read the license and */
|
|
|
|
|
/* understand and accept it fully. */
|
|
|
|
|
/* */
|
|
|
|
|
/***************************************************************************/
|
|
|
|
|
|
2000-07-02 15:53:16 +02:00
|
|
|
|
2000-07-02 03:27:32 +02:00
|
|
|
#ifndef FTOUTLN_H
|
|
|
|
|
#define FTOUTLN_H
|
|
|
|
|
|
2000-07-02 15:53:16 +02:00
|
|
|
|
|
|
|
|
#include <freetype/freetype.h>
|
|
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
|
extern "C" {
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
2000-07-02 03:27:32 +02:00
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Outline_Decompose */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* Walks over an outline's structure to decompose it into individual */
|
|
|
|
|
/* segments and Bezier arcs. This function is also able to emit */
|
|
|
|
|
/* `move to' and `close to' operations to indicate the start and end */
|
|
|
|
|
/* of new contours in the outline. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
|
|
|
|
/* outline :: A pointer to the source target. */
|
|
|
|
|
/* */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* interface :: A table of `emitters', i.e,. function pointers called */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* during decomposition to indicate path operations. */
|
|
|
|
|
/* */
|
2000-11-06 05:33:56 +01:00
|
|
|
/* <InOut> */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* user :: A typeless pointer which is passed to each emitter */
|
|
|
|
|
/* during the decomposition. It can be used to store */
|
|
|
|
|
/* the state during the decomposition. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Return> */
|
|
|
|
|
/* FreeType error code. 0 means sucess. */
|
|
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( FT_Error ) FT_Outline_Decompose(
|
2000-11-04 09:33:38 +01:00
|
|
|
FT_Outline* outline,
|
|
|
|
|
const FT_Outline_Funcs* interface,
|
|
|
|
|
void* user );
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Outline_New */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* Creates a new outline of a given size. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
|
|
|
|
/* library :: A handle to the library object from where the */
|
|
|
|
|
/* outline is allocated. Note however that the new */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* outline will NOT necessarily be FREED, when */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* destroying the library, by FT_Done_FreeType(). */
|
|
|
|
|
/* */
|
|
|
|
|
/* numPoints :: The maximal number of points within the outline. */
|
|
|
|
|
/* */
|
|
|
|
|
/* numContours :: The maximal number of contours within the outline. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Output> */
|
2000-11-06 05:33:56 +01:00
|
|
|
/* anoutline :: A handle to the new outline. NULL in case of */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* error. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Return> */
|
|
|
|
|
/* FreeType error code. 0 means success. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
|
|
|
|
/* The reason why this function takes a `library' parameter is simply */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* to use the library's memory allocator. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( FT_Error ) FT_Outline_New( FT_Library library,
|
|
|
|
|
FT_UInt numPoints,
|
|
|
|
|
FT_Int numContours,
|
2000-11-06 05:33:56 +01:00
|
|
|
FT_Outline *anoutline );
|
2000-07-02 03:27:32 +02:00
|
|
|
|
2000-07-11 08:12:20 +02:00
|
|
|
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( FT_Error ) FT_Outline_New_Internal(
|
2000-11-04 09:33:38 +01:00
|
|
|
FT_Memory memory,
|
|
|
|
|
FT_UInt numPoints,
|
|
|
|
|
FT_Int numContours,
|
2000-11-06 05:33:56 +01:00
|
|
|
FT_Outline *anoutline );
|
2000-07-07 21:47:34 +02:00
|
|
|
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Outline_Done */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* Destroys an outline created with FT_Outline_New(). */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
|
|
|
|
/* library :: A handle of the library object used to allocate the */
|
|
|
|
|
/* outline. */
|
|
|
|
|
/* */
|
|
|
|
|
/* outline :: A pointer to the outline object to be discarded. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Return> */
|
|
|
|
|
/* FreeType error code. 0 means success. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
|
|
|
|
/* If the outline's `owner' field is not set, only the outline */
|
|
|
|
|
/* descriptor will be released. */
|
|
|
|
|
/* */
|
2000-11-06 05:33:56 +01:00
|
|
|
/* The reason why this function takes an `library' parameter is */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* simply to use FT_Free(). */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( FT_Error ) FT_Outline_Done( FT_Library library,
|
|
|
|
|
FT_Outline* outline );
|
2000-07-11 08:12:20 +02:00
|
|
|
|
2000-07-02 03:27:32 +02:00
|
|
|
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( FT_Error ) FT_Outline_Done_Internal( FT_Memory memory,
|
|
|
|
|
FT_Outline* outline );
|
2000-07-07 21:47:34 +02:00
|
|
|
|
2000-07-11 08:12:20 +02:00
|
|
|
|
2000-07-02 03:27:32 +02:00
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Outline_Get_CBox */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* Returns an outline's `control box'. The control box encloses all */
|
|
|
|
|
/* the outline's points, including Bezier control points. Though it */
|
|
|
|
|
/* coincides with the exact bounding box for most glyphs, it can be */
|
|
|
|
|
/* slightly larger in some situations (like when rotating an outline */
|
|
|
|
|
/* which contains Bezier outside arcs). */
|
|
|
|
|
/* */
|
|
|
|
|
/* Computing the control box is very fast, while getting the bounding */
|
|
|
|
|
/* box can take much more time as it needs to walk over all segments */
|
|
|
|
|
/* and arcs in the outline. To get the latter, you can use the */
|
|
|
|
|
/* `ftbbox' component which is dedicated to this single task. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
|
|
|
|
/* outline :: A pointer to the source outline descriptor. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Output> */
|
2000-11-06 05:33:56 +01:00
|
|
|
/* acbox :: The outline's control box. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( void ) FT_Outline_Get_CBox( FT_Outline* outline,
|
2000-11-06 05:33:56 +01:00
|
|
|
FT_BBox *acbox );
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Outline_Translate */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* Applies a simple translation to the points of an outline. */
|
|
|
|
|
/* */
|
2000-11-06 05:33:56 +01:00
|
|
|
/* <InOut> */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* outline :: A pointer to the target outline descriptor. */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* */
|
2000-11-06 05:33:56 +01:00
|
|
|
/* <Input> */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* xOffset :: The horizontal offset. */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* yOffset :: The vertical offset. */
|
|
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( void ) FT_Outline_Translate( FT_Outline* outline,
|
|
|
|
|
FT_Pos xOffset,
|
|
|
|
|
FT_Pos yOffset );
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Outline_Copy */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* Copies an outline into another one. Both objects must have the */
|
|
|
|
|
/* same sizes (number of points & number of contours) when this */
|
|
|
|
|
/* function is called. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
|
|
|
|
/* source :: A handle to the source outline. */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Output> */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* target :: A handle to the target outline. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Return> */
|
|
|
|
|
/* FreeType error code. 0 means success. */
|
|
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( FT_Error ) FT_Outline_Copy( FT_Outline* source,
|
2000-11-06 05:33:56 +01:00
|
|
|
FT_Outline *target );
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
2000-11-07 18:21:11 +01:00
|
|
|
/* FT_Outline_Transform */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
2000-11-07 18:21:11 +01:00
|
|
|
/* Applies a simple 2x2 matrix to all of an outline's points. Useful */
|
|
|
|
|
/* for applying rotations, slanting, flipping, etc. */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* */
|
|
|
|
|
/* <InOut> */
|
2000-11-07 18:21:11 +01:00
|
|
|
/* outline :: A pointer to the target outline descriptor. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
2000-11-07 18:21:11 +01:00
|
|
|
/* matrix :: A pointer to the transformation matrix. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
2000-11-07 18:21:11 +01:00
|
|
|
/* You can use FT_Outline_Translate() if you need to translate the */
|
|
|
|
|
/* outline's points. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( void ) FT_Outline_Transform( FT_Outline* outline,
|
|
|
|
|
FT_Matrix* matrix );
|
2000-07-11 08:12:20 +02:00
|
|
|
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Outline_Reverse */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* Reverses the drawing direction of an outline. This is used to */
|
|
|
|
|
/* ensure consistent fill conventions for mirrored glyphs. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
2000-11-06 05:33:56 +01:00
|
|
|
/* <InOut> */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* outline :: A pointer to the target outline descriptor. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* This functions toggles the bit flag `ft_outline_reverse_fill' in */
|
|
|
|
|
/* the outline's `flags' field. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
|
|
|
|
/* It shouldn't be used by a normal client application, unless it */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* knows what it is doing. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( void ) FT_Outline_Reverse( FT_Outline* outline );
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Outline_Get_Bitmap */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
|
|
|
|
/* Renders an outline within a bitmap. The outline's image is simply */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* OR-ed to the target bitmap. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
|
|
|
|
/* library :: A handle to a FreeType library object. */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* outline :: A pointer to the source outline descriptor. */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* */
|
2000-11-06 05:33:56 +01:00
|
|
|
/* <Output> */
|
|
|
|
|
/* abitmap :: A pointer to the target bitmap descriptor. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Return> */
|
|
|
|
|
/* FreeType error code. 0 means success. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
|
|
|
|
/* This function does NOT CREATE the bitmap, it only renders an */
|
|
|
|
|
/* outline image within the one you pass to it! */
|
|
|
|
|
/* */
|
|
|
|
|
/* It will use the raster correponding to the default glyph format. */
|
|
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( FT_Error ) FT_Outline_Get_Bitmap( FT_Library library,
|
|
|
|
|
FT_Outline* outline,
|
2000-11-06 05:33:56 +01:00
|
|
|
FT_Bitmap *abitmap );
|
2000-07-11 08:12:20 +02:00
|
|
|
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
/*************************************************************************/
|
|
|
|
|
/* */
|
|
|
|
|
/* <Function> */
|
|
|
|
|
/* FT_Outline_Render */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Description> */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* Renders an outline within a bitmap using the current scan-convert. */
|
|
|
|
|
/* This functions uses an FT_Raster_Params structure as an argument, */
|
|
|
|
|
/* allowing advanced features like direct composition, translucency, */
|
|
|
|
|
/* etc. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Input> */
|
|
|
|
|
/* library :: A handle to a FreeType library object. */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* outline :: A pointer to the source outline descriptor. */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* */
|
2000-11-06 05:33:56 +01:00
|
|
|
/* <InOut> */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* params :: A pointer to a FT_Raster_Params structure used to */
|
|
|
|
|
/* describe the rendering operation. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
|
|
|
|
/* <Return> */
|
|
|
|
|
/* FreeType error code. 0 means success. */
|
|
|
|
|
/* */
|
|
|
|
|
/* <Note> */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* You should know what you are doing and how FT_Raster_Params works */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* to use this function. */
|
|
|
|
|
/* */
|
2000-07-11 08:12:20 +02:00
|
|
|
/* The field `params.source' will be set to `outline' before the scan */
|
|
|
|
|
/* converter is called, which means that the value you give to it is */
|
|
|
|
|
/* actually ignored. */
|
2000-07-02 03:27:32 +02:00
|
|
|
/* */
|
2000-11-04 02:55:49 +01:00
|
|
|
FT_EXPORT( FT_Error ) FT_Outline_Render( FT_Library library,
|
|
|
|
|
FT_Outline* outline,
|
|
|
|
|
FT_Raster_Params* params );
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
|
2000-07-02 15:53:16 +02:00
|
|
|
#ifdef __cplusplus
|
|
|
|
|
}
|
|
|
|
|
#endif
|
2000-07-02 03:27:32 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif /* FTOUTLN_H */
|
2000-07-02 15:53:16 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
/* END */
|
