Smirnoffリファレンス

FrontPage

Smirnoffとは†

Smirnoffとは、Spirytusの外部ウィンドウ表示システムが余りに使いにくかったため、新たに開発された外部ウィンドウ表示専用のDLLです。

現行バージョンは0.33で、以下のリファレンスに存在する関数でも未実装のモノがまだあるかもしれません。

↑

Smirnoffの特徴†

ウィンドウを複数作り、それぞれに名前をつけることができる。
ウィンドウ以外にバックバッファを作ることができる（Screenの解説を参照)
エラー処理を行っているので安心

↑

概念・用語解説†

↑

WindowとScreen†

WindowはCreateWindow関数で作られ、実際に画面上に描画される窓そのものである。これに対して、CreateScreen関数で作られるScreenはそのままでは実際に画面上に描画されず、BitBlt関数を使ってWindowに転送(描画）することによって画面に描画される。これ以外の描画についてはWindowとScreenは完全に互換である。

また、Windowを操作する関数の一部にはScreenに対しては使用することができないものがある。このリファレンスではWindowでもScreenでもよい場合にはDrawingHandle、Windowしか使えない場合にはWindowHandle、Screenのみの場合にはScreenHandleと表記する。

任意のDrawingHandleがWindowHandleなのかScreenHandleなのかを取得するにはGetWindowType関数を用いる。

↑

GDIHandle†

GDIHandleとは、WindowやScreenに対してどのような色や幅(線の場合）で描画するのかを示す値である。GDIHandleには

Pen:線描画に使う。CreatePenで作成
Brush:塗りつぶし描画に使う。CreateBrushで作成
Font:文字描画に使う。CreateFontで作成

の3種類がある。GDIHandleを作成したら、SelectObject関数でDrawingHandleに対して設定することで、そのDrawingHandleでの描画される色などを変えることができる。また、DrawingHandleに対してPen,Brush,Fontはそれぞれ別々に設定されるので、Penをどう設定しても塗りつぶしの色は変わらないしBrushをどう設定しても線描画の色は変わらない。

なお、任意のGDIHandleがPenなのかBrushなのかFontなのかを取得するにはGetGDIHandleType関数を用いる。

↑

リファレンス†

↑

総則†

↑

number SMIRNOFF_VERSION†

DLLのバージョンが浮動小数で入っている。

↑

全ての関数は、リファレンスにvoid型と書いてあっても内部でエラーが発生した場合は、†

false, エラーメッセージ

の2つの値を返す。assertでそのまま拾えばエラーの内容を取得できる

↑

Window,Screen操作関係†

↑

WindowHandle CreateWindow(width, height, name)†

窓を作成する。

widdth:作成するWindowの幅。
height:作成するWindowの高さ。
name:作成するWindowの名前。タイトルバーに表示される
return:作成したWindowHandle。詳しくはWindowとScreenの説明を見よ。

↑

ScreenHandle CreateScreen(BaseWindow, width, height)†

Screen（内部描画バッファ）を作成する。

baseWindow:描画対象となるウィンドウのWindowHandle。（ただし、実質的にはどのウィンドウのハンドルでもいい）
width:作成するバッファの幅。
height:作成するバッファの高さ。
return :作成したScreenHandle。詳しくはWindowとScreenの説明を見よ。

↑

void DestroyWindow(DrawingHandle)†

WindowやScreenを破棄する。

DrawingHandle:破棄する窓かScreenのハンドル。

↑

void MoveWindow(WindowHandle, x, y)†

窓を移動する

WindowHandle:移動する窓のハンドル
x:窓の左上の移動先のX座標（スクリーン座標）
y:窓の左上の移動先のY座標（スクリーン座標）

↑

int,int GetWindowPos(WindowHandle)†

窓の位置を取得する

return1:現在の窓の左上のX座標（スクリーン座標）
return2:現在の窓の左上のY座標（スクリーン座標）

↑

void ResizeWindow(WindowHandle, width, height)†

Windowのサイズを変更する。クライアント領域がwidth*heightになるようにリサイズするので、フチなどを含めた実際のWindowのサイズはコレよりも大きくなる

WindowHandle:リサイズする窓のハンドル
width:リサイズ後の窓の幅
height:リサイズ後の窓の幅

↑

int,int GetWindowSize(DrawingHandle)†

WindowやScreenのサイズを取得する。取得するのはクライアント領域のサイズなので、Windowの場合は実際のサイズはコレよりも大きくなる DrawingHandle:サイズを取得する窓のハンドル return1:DrawingHandleの横幅 return2:DrawingHandleの高さ

↑