Skip to content

Commit

Permalink
better doc
Browse files Browse the repository at this point in the history
  • Loading branch information
UlyssesWu committed Jul 14, 2018
1 parent f4f0918 commit 4db5e0b
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 51 deletions.
Binary file modified TlgLib/TlgLib.h
Binary file not shown.
20 changes: 10 additions & 10 deletions TlgLib/libtlg/SaveTLG.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,16 @@ extern int SaveTLG6(tTJSBinaryStream *out, int width, int height, int colors, vo
//---------------------------------------------------------------------------

/**
* TLG画像のセーブ
* @param dest 格納先ストリーム
* @param type 種別 0:TLG5 1:TLG6
* @parma width 画像横幅
* @param height 画像縦幅
* @param colors 色数指定 1:8bitグレー 3:RGB 4:RGBA
* @param callbackdata コールバック用データ
* @param scanlinecallback セーブデータ通知用コールバック(データが入っているアドレスを渡す)
* @param tags 保存するタグ情報
* @return 0:成功 1:中断 -1:エラー
* Encode TLG image
* @param dest output stream
* @param type 0:TLG5 1:TLG6
* @parma width
* @param height
* @param colors 1:8bit Gray 3:RGB 4:RGBA
* @param callbackdata pass data
* @param scanlinecallback pass bitmap line data
* @param tags Tag dictionary
* @return 0:success 1:break -1:error
*/
int
TVPSaveTLG(tTJSBinaryStream *dest,
Expand Down
40 changes: 20 additions & 20 deletions TlgLib/libtlg/TLG.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,23 +61,23 @@ TVPCheckTLG(tTJSBinaryStream* src);

/**
* Get TLG image info
* @param src 読み込み元ストリーム
* @param width 横幅情報格納先
* @parma height 縦幅情報格納先
* @param src input stream
* @param width
* @parma height
* @parma version (Added by Ulysses) TLG Version: 0=unknown, 5=v5, 6=v6
*/
extern bool
TVPGetInfoTLG(tTJSBinaryStream* src, int* width, int* height, int* version);

/**
* Load TLG image
* @param dest 読み込み元ストリーム
* @param callbackdata
* @param sizecallback サイズ情報格納用コールバック
* @param scanlinecallback ロードデータ格納用コールバック
* @param tags 読み込んだタグ情報の格納先
* Decode TLG image
* @param src input stream
* @param callbackdata pass data
* @param sizecallback get size info
* @param scanlinecallback output bitmap line data
* @param tags Tag dictionary
* @param tlgVersion (Added by Ulysses) TLG Version: 0=unknown, 5=v5, 6=v6
* @return 0:成功 1:中断 -1:エラー
* @return 0:success 1:break -1:error
*/
extern int
TVPLoadTLG(void *callbackdata,
Expand All @@ -87,16 +87,16 @@ TVPLoadTLG(void *callbackdata,
tTJSBinaryStream *src, int* tlgVersion = 0);

/**
* Save TLG image
* @param dest 格納先ストリーム
* @param type 種別 0:TLG5 1:TLG6
* @parma width 画像横幅
* @param height 画像縦幅
* @param colors 色数指定 1:8bitグレー 3:RGB 4:RGBA
* @param callbackdata コールバック用データ
* @param scanlinecallback セーブデータ通知用コールバック(データが入っているアドレスを渡す)
* @param tags 保存するタグ情報
* @return 0:成功 1:中断 -1:エラー
* Encode TLG image
* @param dest output stream
* @param type Type 0:TLG5 1:TLG6
* @parma width
* @param height
* @param colors 1:8bit Gray 3:RGB 4:RGBA
* @param callbackdata pass data
* @param scanlinecallback pass bitmap line data
* @param tags Tag dictionary
* @return 0:success 1:break -1:error
*/
extern int
TVPSaveTLG(tTJSBinaryStream *dest,
Expand Down
14 changes: 7 additions & 7 deletions TlgLib/libtlg/TLG5Saver.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@
#define BLOCK_HEIGHT 4

/**
* TLG5画像の保存
* @param out 出力先
* @param width 画像横幅
* @param height 画像縦幅
* @param colors 色数指定 1/3/4
* @param callback コールバック用パラメータ
* @param scanlinecallback 行データを返すコールバック。NULL を返すと中断される。1つ前に渡したバッファは有効である必要がある
* Encode TLG5 Image
* @param out output stream
* @param width
* @param height
* @param colors bytes per pixel 1/3/4
* @param callback pass needed data
* @param scanlinecallback get bitmap line data, pass NULL to break process.
*/
int
SaveTLG5(tTJSBinaryStream *out,
Expand Down
14 changes: 7 additions & 7 deletions TlgLib/libtlg/TLG6Saver.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -769,13 +769,13 @@ static void TLG6InitializeColorFilterCompressor(SlideCompressor &c)
// int ftfreq[256] = {0};

/**
* TLG6画像の保存
* @param out 出力先
* @param width 画像横幅
* @param height 画像縦幅
* @param colors 色数指定 1/3/4
* @param callback コールバック用パラメータ
* @param scanlinecallback 行データを返すコールバック。NULL を返すと中断される。1つ前に渡したバッファは有効である必要がある
* Encode TLG6 image
* @param out output stream
* @param width
* @param height
* @param colors bytes per pixel 1/3/4
* @param callback pass needed data
* @param scanlinecallback et bitmap line data, pass NULL to break process.
*/
int
SaveTLG6(tTJSBinaryStream *out,
Expand Down
4 changes: 2 additions & 2 deletions TlgLib/libtlg/handlestream.cpp
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
#include "handlestream.h"

/**
* ハンドル指定で開く
* open Handle
*/
tHandleStream::tHandleStream(HANDLE handle) : handle(handle), release(false)
{
}

/**
* ファイル名指定で開く
* open file
*/
tHandleStream::tHandleStream(const char *filename, DWORD mode) : release(true)
{
Expand Down
8 changes: 4 additions & 4 deletions TlgLib/libtlg/handlestream.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,24 @@
#include <windows.h>

/**
* ハンドル/ファイル版
* FileStream
*/
class tHandleStream : public tTJSBinaryStream {

public:
/**
* ハンドル指定で開く(ハンドルは解放されません)
* open Handle (won't dispose)
*/
tHandleStream(HANDLE handle);

/**
* ファイル名指定で開く
* open file
* @param mode
*/
tHandleStream(const char *filename, DWORD mode=GENERIC_READ);

/**
* ファイル名指定で開く
* open file
* @param mode
*/
tHandleStream(const wchar_t *filename, DWORD mode = GENERIC_READ);
Expand Down
2 changes: 1 addition & 1 deletion TlgLib/libtlg/memstream.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#include <windows.h>
#pragma comment(lib,"Ole32.lib")
/**
* Memory only stream
* MemoryStream
*/
class tMemoryStream : public tTJSBinaryStream
{
Expand Down

0 comments on commit 4db5e0b

Please sign in to comment.