freetype-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[freetype2] master 52f2a00: Update TT_New_Context documentation


From: Werner Lemberg
Subject: [freetype2] master 52f2a00: Update TT_New_Context documentation
Date: Fri, 2 Apr 2021 05:03:00 -0400 (EDT)

branch: master
commit 52f2a008f171a820007a1bc71b44eb736e69500c
Author: Ben Wagner <bungeman@chromium.org>
Commit: Werner Lemberg <wl@gnu.org>

    Update TT_New_Context documentation
    
    In commit 531d463aed365b
    
      [truetype] Allocate TT_ExecContext in TT_Size instead of TT_Driver.
    
    the `TT_ExecContext` was moved from being on the driver to being on the size
    to make it easier to use FreeType in a multi-threaded environment.  However,
    the documentation for `TT_New_Context` was not updated and still reflects
    the old behavior and parameter list.
    
    This change updates `TT_New_Context` documentation to reflect the current
    parameters and usage.
---
 src/truetype/ttinterp.h | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/src/truetype/ttinterp.h b/src/truetype/ttinterp.h
index 98bd8cb..a7578f8 100644
--- a/src/truetype/ttinterp.h
+++ b/src/truetype/ttinterp.h
@@ -476,16 +476,15 @@ FT_BEGIN_HEADER
    *   TT_New_Context
    *
    * @Description:
-   *   Queries the face context for a given font.  Note that there is
-   *   now a _single_ execution context in the TrueType driver which is
-   *   shared among faces.
+   *   Create a `TT_ExecContext`.  Note that there is now an execution
+   *   context per `TT_Size` that is not shared among faces.
    *
    * @Input:
-   *   face ::
-   *     A handle to the source face object.
+   *   driver ::
+   *     A handle to the driver, used for memory allocation.
    *
    * @Return:
-   *   A handle to the execution context.  Initialized for `face'.
+   *   A handle to a new empty execution context.
    *
    * @Note:
    *   Only the glyph loader and debugger should call this function.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]