diff options
Diffstat (limited to 'src/3rdparty/libmng/doc')
| -rw-r--r-- | src/3rdparty/libmng/doc/libmng.txt | 42 | ||||
| -rw-r--r-- | src/3rdparty/libmng/doc/man/libmng.3 | 42 |
2 files changed, 42 insertions, 42 deletions
diff --git a/src/3rdparty/libmng/doc/libmng.txt b/src/3rdparty/libmng/doc/libmng.txt index 95c086db6..a18940bbe 100644 --- a/src/3rdparty/libmng/doc/libmng.txt +++ b/src/3rdparty/libmng/doc/libmng.txt @@ -97,7 +97,7 @@ with the given size. A typical implementation would be: return calloc (1, iSize); } -Note that the library retquires you to zero-out the memory-block!!! +Note that the library requires you to zero-out the memory-block!!! - void mng_memfree (mng_ptr pPtr, mng_size_t iLen) @@ -127,7 +127,7 @@ reading an image. The reading process supports two modes: Suspension-mode (SMOD) and non-suspension-mode (NSMOD). See mng_set_suspensionmode() for a more detailed description. -In NSMOD, the library retquires you to return exactly the amount of bytes +In NSMOD, the library requires you to return exactly the amount of bytes requested (= iBuflen). Any lesser amount indicates the input file is exhausted and the library will return a MNG_UNEXPECTEDEOF errorcode. @@ -279,7 +279,7 @@ clock. The entire animation timing depends heavily on this function, - mng_bool mng_settimer (mng_handle hHandle, mng_uint32 iMsecs) -This callback is activated every time the library retquires a "pause". +This callback is activated every time the library requires a "pause". Note that the function itself should NOT execute the wait. It should simply store the time-field and allow the library to return. Libmng will return with the MNG_NEEDTIMERWAIT code, indicating the callback @@ -313,7 +313,7 @@ settimer() callbacks are crucial for proper animation timing. mng_bool bIsRGBA16, mng_ptr pRow) -These callbacks are only retquired when you selected the MNG_APP_CMS +These callbacks are only required when you selected the MNG_APP_CMS directive during compilation of the library. See the configuration section for more details. @@ -384,9 +384,9 @@ This function will clear all internal state variables, free any stored chunks and/or objects, etc, etc. Your callbacks and other external parameters will be retained. -After you successfully received the handle it is time to set the retquired +After you successfully received the handle it is time to set the required callbacks. The sections on reading, displaying & writing indicate which -callbacks are retquired and which are optional. +callbacks are required and which are optional. To set the callbacks simply do: myretcode = mng_setcb_xxxxxx (myhandle, my_xxxxxx); @@ -492,7 +492,7 @@ input. This allows your application to receive data of arbitrarily length and return this in the mng_readdata() callback, without disturbing the chunk processing routines of the library. -Suspension-mode does retquire a little extra care in the main logic of the +Suspension-mode does require a little extra care in the main logic of the 1application. The read function may return with MNG_NEEDMOREDATA when the mng_readdata() callback returns less data then it needs to process the next chunk. This indicates the application to wait for more data to arrive @@ -547,7 +547,7 @@ until it either reaches EOF (indicated by the mng_readdata() callback) or implicitly decides EOF as it processed the logically last chunk of the image. -Applications that retquire strict conformity and do not allow superfluous +Applications that require strict conformity and do not allow superfluous data after the ending chunk, will need to perform this check in their mng_closestream() callback. @@ -578,7 +578,7 @@ mng_set_storechunks() function. If set to MNG_TRUE, chunks will be stored as they are read. At any point you can then call the mng_iterate_chunks() function -to iterate through the current list of chunks. This function retquires +to iterate through the current list of chunks. This function requires a callback which is called for each chunk and receives a specific chunk-handle. This chunk-handle can be used to call the appropriate mng_getchunk_xxxx() function, to access the chunks properties. @@ -663,7 +663,7 @@ If you like to do alpha composition yourself you can select one of the canvas styles that include an alpha channel. You can even have a separate alpha canvas by selecting the MNG_CANVAS_RGB8_A8 style. -All styles retquire a compact model. Eg. MNG_CANVAS_BGR8 retquires +All styles require a compact model. Eg. MNG_CANVAS_BGR8 requires your canvas lines in bgrbgrbgr... storage, where each letter represents an 8-bit value of the corresponding color, and each threesome makes up the values of one(1) pixel. @@ -674,7 +674,7 @@ actually need to be consecutive in memory. > Alpha composition and application backgrounds -All Network Graphics can be partially transparent. This retquires +All Network Graphics can be partially transparent. This requires special processing if you need to display an image against some background. Note that the MNG header (MHDR chunk) contains a simplicity field indicating whether transparency information in @@ -700,7 +700,7 @@ set the values of the red, green and blue component of your preferred background color. Use one of the canvas styles that do not have an alpha-channel, and -which matches your output retquirements. +which matches your output requirements. > Composing against a background canvas @@ -713,7 +713,7 @@ be composed. Its size must match exactly with the image dimensions and thus the drawing canvas! Use one of the canvas styles that do not have an alpha-channel, and -which matches your output retquirements. The canvas style of the +which matches your output requirements. The canvas style of the background canvas may even differ from the drawing canvas. The library's composing will still function properly. @@ -783,7 +783,7 @@ Images will definitely not be displayed as seen by the Author!!! > Animations and timing -Animations retquire some form of timing support. The library relies +Animations require some form of timing support. The library relies on two callbacks for this purpose. The mng_gettickcount() and mng_settimer() callbacks. mng_gettickcount() is used to determine the passing of time in milliseconds since the beginning of the @@ -798,7 +798,7 @@ input from an internal clock. The value returned from this function is more than adequate for libmng. The mng_settimer() callback is called when the library determines -a little "pause" is retquired before rendering another frame of the +a little "pause" is required before rendering another frame of the animation. The pause interval is also expressed in milliseconds. Your application should store this value and return immediately. The library will then make appropriate arrangements to store its @@ -836,7 +836,7 @@ applications as well. The method is usually used in unison with the suspension-mode of the read module. A typical implementation would look like this: - /* initiale library and set retquired callbacks */ + /* initiale library and set required callbacks */ /* activate suspension-mode */ myretcode = mng_set_suspensionmode (myhandle, @@ -859,7 +859,7 @@ the read module. A typical implementation would look like this: if (myretcode != MNG_NOERROR) /* process error */; -More advanced programming methods may retquire a different approach, +More advanced programming methods may require a different approach, but the final result should function as in the code above. @@ -881,7 +881,7 @@ Once you have successfully read the file, all you need to do is: if (myretcode != MNG_NOERROR) /* process error */; -Again, more advanced programming methods may retquire a different +Again, more advanced programming methods may require a different approach, but the final result should function as in the code above. @@ -1004,7 +1004,7 @@ write it out as a copy or something. You MUST have compiled the library with the MNG_STORE_CHUNKS directive, and you must have done mng_set_storechunks (myhandle, MNG_TRUE). -This doesn't retquire the MNG_ACCESS_CHUNKS directive, unless you want +This doesn't require the MNG_ACCESS_CHUNKS directive, unless you want to fiddle with the chunks as well. Again all you need to do is: @@ -1094,8 +1094,8 @@ Remarks : Parts of this software have been adapted from the libpng library. Although this library supports all features from the PNG specification -(as MNG descends from it) it does not retquire the libpng library. -It does retquire the zlib library and optionally the IJG JPEG library, +(as MNG descends from it) it does not require the libpng library. +It does require the zlib library and optionally the IJG JPEG library, and/or the "little-cms" library by Marti Maria Saguer (depending on the inclusion of support for JNG and Full-Color-Management respectively. diff --git a/src/3rdparty/libmng/doc/man/libmng.3 b/src/3rdparty/libmng/doc/man/libmng.3 index c86faf615..bdc474577 100644 --- a/src/3rdparty/libmng/doc/man/libmng.3 +++ b/src/3rdparty/libmng/doc/man/libmng.3 @@ -107,7 +107,7 @@ with the given size. A typical implementation would be: return calloc (1, iSize); } -Note that the library retquires you to zero-out the memory-block!!! +Note that the library requires you to zero-out the memory-block!!! \- void mng_memfree (mng_ptr pPtr, mng_size_t iLen) @@ -138,7 +138,7 @@ reading an image. The reading process supports two modes: Suspension-mode (SMOD) and non-suspension-mode (NSMOD). See mng_set_suspensionmode() for a more detailed description. -In NSMOD, the library retquires you to return exactly the amount of bytes +In NSMOD, the library requires you to return exactly the amount of bytes requested (= iBuflen). Any lesser amount indicates the input file is exhausted and the library will return a MNG_UNEXPECTEDEOF errorcode. @@ -293,7 +293,7 @@ clock. The entire animation timing depends heavily on this function, \- mng_bool mng_settimer (mng_handle hHandle, mng_uint32 iMsecs) -This callback is activated every time the library retquires a "pause". +This callback is activated every time the library requires a "pause". Note that the function itself should NOT execute the wait. It should simply store the time-field and allow the library to return. Libmng will return with the MNG_NEEDTIMERWAIT code, indicating the callback @@ -331,7 +331,7 @@ settimer() callbacks are crucial for proper animation timing. mng_bool bIsRGBA16, mng_ptr pRow) -These callbacks are only retquired when you selected the MNG_APP_CMS +These callbacks are only required when you selected the MNG_APP_CMS directive during compilation of the library. See the configuration section for more details. @@ -402,9 +402,9 @@ This function will clear all internal state variables, free any stored chunks and/or objects, etc, etc. Your callbacks and other external parameters will be retained. -After you successfully received the handle it is time to set the retquired +After you successfully received the handle it is time to set the required callbacks. The sections on reading, displaying & writing indicate which -callbacks are retquired and which are optional. +callbacks are required and which are optional. To set the callbacks simply do: myretcode = mng_setcb_xxxxxx (myhandle, my_xxxxxx); @@ -510,7 +510,7 @@ input. This allows your application to receive data of arbitrarily length and return this in the mng_readdata() callback, without disturbing the chunk processing routines of the library. -Suspension-mode does retquire a little extra care in the main logic of the +Suspension-mode does require a little extra care in the main logic of the 1application. The read function may return with MNG_NEEDMOREDATA when the mng_readdata() callback returns less data then it needs to process the next chunk. This indicates the application to wait for more data to arrive @@ -565,7 +565,7 @@ until it either reaches EOF (indicated by the mng_readdata() callback) or implicitly decides EOF as it processed the logically last chunk of the image. -Applications that retquire strict conformity and do not allow superfluous +Applications that require strict conformity and do not allow superfluous data after the ending chunk, will need to perform this check in their mng_closestream() callback. @@ -596,7 +596,7 @@ mng_set_storechunks() function. If set to MNG_TRUE, chunks will be stored as they are read. At any point you can then call the mng_iterate_chunks() function -to iterate through the current list of chunks. This function retquires +to iterate through the current list of chunks. This function requires a callback which is called for each chunk and receives a specific chunk-handle. This chunk-handle can be used to call the appropriate mng_getchunk_xxxx() function, to access the chunks properties. @@ -681,7 +681,7 @@ If you like to do alpha composition yourself you can select one of the canvas styles that include an alpha channel. You can even have a separate alpha canvas by selecting the MNG_CANVAS_RGB8_A8 style. -All styles retquire a compact model. Eg. MNG_CANVAS_BGR8 retquires +All styles require a compact model. Eg. MNG_CANVAS_BGR8 requires your canvas lines in bgrbgrbgr... storage, where each letter represents an 8-bit value of the corresponding color, and each threesome makes up the values of one(1) pixel. @@ -692,7 +692,7 @@ actually need to be consecutive in memory. .SS Alpha composition and application backgrounds -All Network Graphics can be partially transparent. This retquires +All Network Graphics can be partially transparent. This requires special processing if you need to display an image against some background. Note that the MNG header (MHDR chunk) contains a simplicity field indicating whether transparency information in @@ -718,7 +718,7 @@ set the values of the red, green and blue component of your preferred background color. Use one of the canvas styles that do not have an alpha-channel, and -which matches your output retquirements. +which matches your output requirements. .SS Composing against a background canvas @@ -731,7 +731,7 @@ be composed. Its size must match exactly with the image dimensions and thus the drawing canvas! Use one of the canvas styles that do not have an alpha-channel, and -which matches your output retquirements. The canvas style of the +which matches your output requirements. The canvas style of the background canvas may even differ from the drawing canvas. The library's composing will still function properly. @@ -801,7 +801,7 @@ Images will definitely not be displayed as seen by the Author!!! .SS Animations and timing -Animations retquire some form of timing support. The library relies +Animations require some form of timing support. The library relies on two callbacks for this purpose. The mng_gettickcount() and mng_settimer() callbacks. mng_gettickcount() is used to determine the passing of time in milliseconds since the beginning of the @@ -816,7 +816,7 @@ input from an internal clock. The value returned from this function is more than adequate for libmng. The mng_settimer() callback is called when the library determines -a little "pause" is retquired before rendering another frame of the +a little "pause" is required before rendering another frame of the animation. The pause interval is also expressed in milliseconds. Your application should store this value and return immediately. The library will then make appropriate arrangements to store its @@ -854,7 +854,7 @@ applications as well. The method is usually used in unison with the suspension-mode of the read module. A typical implementation would look like this: - /* initiale library and set retquired callbacks */ + /* initiale library and set required callbacks */ /* activate suspension-mode */ myretcode = mng_set_suspensionmode (myhandle, @@ -877,7 +877,7 @@ the read module. A typical implementation would look like this: if (myretcode != MNG_NOERROR) /* process error */; -More advanced programming methods may retquire a different approach, +More advanced programming methods may require a different approach, but the final result should function as in the code above. @@ -899,7 +899,7 @@ Once you have successfully read the file, all you need to do is: if (myretcode != MNG_NOERROR) /* process error */; -Again, more advanced programming methods may retquire a different +Again, more advanced programming methods may require a different approach, but the final result should function as in the code above. @@ -1024,7 +1024,7 @@ write it out as a copy or something. You MUST have compiled the library with the MNG_STORE_CHUNKS directive, and you must have done mng_set_storechunks (myhandle, MNG_TRUE). -This doesn't retquire the MNG_ACCESS_CHUNKS directive, unless you want +This doesn't require the MNG_ACCESS_CHUNKS directive, unless you want to fiddle with the chunks as well. Again all you need to do is: @@ -1133,8 +1133,8 @@ source code in a product, acknowledgment would be highly appreciated. Parts of this software have been adapted from the libpng library. Although this library supports all features from the PNG specification -(as MNG descends from it) it does not retquire the libpng library. -It does retquire the zlib library and optionally the IJG JPEG library, +(as MNG descends from it) it does not require the libpng library. +It does require the zlib library and optionally the IJG JPEG library, and/or the "little-cms" library by Marti Maria Saguer (depending on the inclusion of support for JNG and Full-Color-Management respectively. |