freetype-commit
[Top][All Lists]
Advanced

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

[Git][freetype/freetype][master] * include/freetype/ftsystem.h (FT_Strea


From: Werner Lemberg (@wl)
Subject: [Git][freetype/freetype][master] * include/freetype/ftsystem.h (FT_Stream_IoFunc): Improve documentation.
Date: Thu, 16 Mar 2023 04:27:51 +0000

Werner Lemberg pushed to branch master at FreeType / FreeType

Commits:

  • 7be364c6
    by Werner Lemberg at 2023-03-16T05:26:48+01:00
    * include/freetype/ftsystem.h (FT_Stream_IoFunc): Improve documentation.
    
    Fixes #1208.
    

1 changed file:

Changes:

  • include/freetype/ftsystem.h
    ... ... @@ -229,8 +229,7 @@ FT_BEGIN_HEADER
    229 229
        *     A handle to the source stream.
    
    230 230
        *
    
    231 231
        *   offset ::
    
    232
    -   *     The offset from the start of the stream to seek to if this is a seek
    
    233
    -   *     operation (see note).
    
    232
    +   *     The offset from the start of the stream to seek to.
    
    234 233
        *
    
    235 234
        *   buffer ::
    
    236 235
        *     The address of the read buffer.
    
    ... ... @@ -239,16 +238,9 @@ FT_BEGIN_HEADER
    239 238
        *     The number of bytes to read from the stream.
    
    240 239
        *
    
    241 240
        * @return:
    
    242
    -   *   The number of bytes effectively read by the stream.
    
    243
    -   *
    
    244
    -   * @note:
    
    245
    -   *   This function performs a seek *or* a read operation depending on the
    
    246
    -   *   argument values.  If `count` is zero, the operation is a seek to
    
    247
    -   *   `offset` bytes.  If `count` is >~0, the operation is a read of `count`
    
    248
    -   *   bytes from the current position in the stream, and the `offset` value
    
    249
    -   *   should be ignored.
    
    250
    -   *
    
    251
    -   *   For seek operations, a non-zero return value indicates an error.
    
    241
    +   *   If count >~0, return the number of bytes effectively read by the
    
    242
    +   *   stream (after seeking to `offset`).  If count ==~0, return the status
    
    243
    +   *   of the seek operation (non-zero indicates an error).
    
    252 244
        *
    
    253 245
        */
    
    254 246
       typedef unsigned long
    


  • reply via email to

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