API version 10

CanvasView.Snapshotメソッド 変更履歴

iOSAndroidWindows

 

説明

CanvasViewに描画された画像を取得します。

 

取得される画像のサイズは、CanvasViewの画面上の表示サイズ(単位:ピクセル)にscale引数の値を掛けたものとなります。

計算式は下記の通りです。

 

  (保存画像の)Image.Width = CanvasView.Width * (横方向の合計スケーリング倍率) * scale引数値

  (保存画像の)Image.Height = CanvasView.Height * (縦方向の合計スケーリング倍率) * scale引数値

 

合計スケーリング倍率は、「スケーリング設定」で適用した倍率と、自身の祖先のFormオブジェクトのスケーリング倍率を乗算したものとなります。

 

例として、Width=300, Height=200のCanvasViewに、水平スケールが0.5倍適用されている場合、取得される画像のサイズは150×200ピクセルとなります。

 

呼出形式

CanvasView.Snapshot( [scale [, drawBackgroundImage [, applyZoom]]] )

 

戻り値

Imageオブジェクト

 

引数

Number scale

表示サイズに対する取得される画像の倍率を0倍より大きい値で指定します。

画像の拡大/縮小加工が必要な場合、scale引数で倍率を指定することで、より高精細な画像を得ることが出来ます。

1.0の場合は等倍で取得されます。

デフォルトは1.0です。

 

boolean drawBackgroundImage

保存する画像に背景画像を含めるか否かを指定します。

trueを指定した場合、SetImageメソッドでセットされた背景画像が含まれます。また、背景色は白(#FFFFFFFF)となります。

falseを指定した場合、背景画像は描画されません。また、背景色は透明(#00000000)となります。

デフォルトはfalseです。

 

boolean applyZoom

ピンチ操作で拡大表示されている画像を出力するかどうかを指定します。 *1

全体画像の一部が切り出されて出力されます。

trueを指定した場合、ピンチ操作で拡大表示されている画像を出力します。

falseを指定した場合、ピンチ操作による拡大表示が無視された画像が出力されます。

デフォルトはfalseです。

例外

FUNC-4

引数が不正です

 

使用例

var img = CanvasView1.Snapshot(); /* 等倍, 背景無しの透過画像で出力 */

 

関連項目

 

変更履歴
*1 API version 25から追加されました。


「オンラインマニュアル」一覧へ戻る
「Bizの宝箱」TOPへ戻る