Rikkymodule/関数一覧/image

このページでは、Rikkymoduleで追加される関数を解説する。

オブジェクトの画像データを一時保存できます

* 第1引数で指定する文字列によって、書き、読み、消し、ID検索などが決定します

第1引数の文字列

```
 boolean = rikky\_module.image("w", string or number [, string])

```

* 書き込みたいIDを文字列か数値で指定します
* 第3引数に"tempbuffer"を指定すると、仮想バッファのイメージを保存できます
* 成功するとtrue、失敗するとfalseのブーリアンを返します

```
 boolean = rikky\_module.image("w+", string or number)

```

* 書き込みたいIDを文字列か数値で指定します
* 透明度やobj.alphaの数値をイメージのアルファ値に乗算します
* 成功するとtrue、失敗するとfalseのブーリアンを返します

```
 boolean = rikky\_module.image("r", string or number)

```

* 呼び出したいIDを文字列か数値で指定します
* 成功するとtrue、失敗するとfalseのブーリアンを返します
* 新しく呼び出しているのでobj.oxなどの値は初期化されます

```
 boolean = rikky\_module.image("r+", string or number)

```

* 呼び出したいIDを文字列か数値で指定します
* 成功するとtrue、失敗するとfalseのブーリアンを返します
* 呼び出す前のobj.oxなどを引き継ぎます

```
 boolean = rikky\_module.image("c", string or number)

```

* 消去したいIDを文字列か数値で指定します
* 成功するとtrue、失敗するとfalseのブーリアンを返します

```
 boolean = rikky\_module.image("c+")

```

* 書き込んだすべてのイメージを消去します
* 成功するとtrue、失敗するとfalseのブーリアンを返します

```
 number or talbe = rikky\_module.image("g" [, number])

```

* まだ使われていないIDの数値を返します
	+ 0以上の数値です
* 第2引数に0より大きい数値を渡すと、その分だけ未使用のID番号をテーブルで返します

```
 table = rikky\_module.image("g+")

```

* 既に書き込まれているIDが収められたテーブルを返します

```
 userdata, number, number = rikky\_module.image("m", string or number, string or number [, number, number])

```

* 第2引数で背面のイメージIDを指定し、第3引数で前面に来るイメージIDを指定します
* 第4引数はx座標の数値、第5引数y座標の数値を指定します
	+ 背面イメージの左上が0、0です
	+ 省略した場合は0、0と同じになります
* 合成結果はイメージのユーザーデータ、横幅の数値、縦幅の数値の3つを返します
	+ ただし、合成に失敗した場合はfalseのブーリアンを返します

### "m+"

書き込まれたイメージを合成します

```
 boolean = rikky\_module.image("m+", string or number, string or number [, number, number])

```

* 合成をして、同時にそのイメージを読み込みます
	+ 読み込むときは"r+"と同じ処理になります
* 第2引数で背面のイメージIDを指定し、第3引数で前面に来るイメージIDを指定します
* 第4引数はx座標の数値、第5引数y座標の数値を指定します
	+ 背面イメージの左上が0、0です
	+ 省略した場合は0、0と同じになります
* 成功するとtrue、失敗するとfalseのブーリアンを返します

### "i"

イメージデータ情報を取得します

```
 userdata, number, number = rikky\_module.image("i", string or number)

```

* イメージ情報を取得したいIDを文字列か数値で指定します
* 戻り値はイメージのユーザーデータ、横幅の数値、縦幅の数値の3つを返します

### "i+"

イメージデータ情報を取得します

```
 table, number, number = rikky\_module.image("i+", string or number)

```

* イメージ情報を取得したいIDを文字列か数値で指定します
* 戻り値はイメージのARGBの情報をもったテーブル、横幅の数値、縦幅の数値の3つを返します
	+ テーブルのキーはA、R、G、Bの4つで、それぞれ0から255までの数値をピクセルの数だけ持っています

### "p"

指定したIDのイメージに別の指定したIDのイメージをコピーします

```
 boolean = rikky\_module.image("p", string or number, string or number or userdata, [ number, number])

```

* 第2引数はコピーイメージを置きたいID、第3引数はコピー元のIDを文字列か数値で指定します
* 第3引数をuserdataにした場合は、横幅を第4引数、縦幅を第5引数に渡してください
* 成功するとtrue、失敗するとfalseのブーリアンを返します

### "p+"

指定したIDのイメージに別の指定したIDのイメージをコピーします

```
 boolean = rikky\_module.image("p+", string or number, string or number or userdata, [ number, number])

```

* 第2引数はコピーイメージを置きたいID、第3引数はコピー元のIDを文字列か数値で指定します
* 第3引数をuserdataにした場合は、横幅を第4引数、縦幅を第5引数に渡してください
* 成功するとtrue、失敗するとfalseのブーリアンを返します
	+ コピー先に既にイメージがある場合は失敗になります

### "u"

指定したIDまたは渡したuserdataの指定した位置の色と透明度を取得します

```
 number, number = rikky\_module.image("u", string or number or userdata, number [, number, number, number])

```

* 色の数値は0から0xFFFFFF、透明度は0から1です
* IDを指定した場合とuserdataを指定した場合で引数が変わってきます
	+ また取得したい色の位置の指定方法でも引数が変わってきます
* IDを指定した場合、第3引数または第3引数と第4引数が色の位置を指定する部分になります
	+ 第3引数のみの場合はその数値の位置の色情報、第4引数も渡すと横と縦の位置の色情報を返すようになります
		- 例えば10×10で第3引数のみ99だと右下の色情報、第3引数を10、第4引数を10にすると右下の色情報になります
* userdataを指定した場合、userdataの縦幅と横幅を渡す必要があります
	+ 色の位置を1つの数値だけで指定する場合は第4引数に横幅、第5引数に縦幅の数値を渡します
	+ 色の位置を縦と横の位置で指定した場合は第5引数に横幅、第6引数に縦幅の数値を渡します

### "u+"

指定したIDまたは渡したuserdataの指定した位置の色のRとGとBと透明度を取得します

```
 number, number, number, number = rikky\_module.image("u", string or number or userdata, number [, number, number, number])

```

* 色の数値はRが0から255、Gが0から255、Bが0から255、透明度は0から255です
* IDを指定した場合とuserdataを指定した場合で引数が変わってきます
	+ また取得したい色の位置の指定方法でも引数が変わってきます
* IDを指定した場合、第3引数または第3引数と第4引数が色の位置を指定する部分になります
	+ 第3引数のみの場合はその数値の位置の色情報、第4引数も渡すと横と縦の位置の色情報を返すようになります
		- 例えば10×10で第3引数のみ99だと右下の色情報、第3引数を10、第4引数を10にすると右下の色情報になります
* userdataを指定した場合、userdataの縦幅と横幅を渡す必要があります
	+ 色の位置を1つの数値だけで指定する場合は第4引数に横幅、第5引数に縦幅の数値を渡します
	+ 色の位置を縦と横の位置で指定した場合は第5引数に横幅、第6引数に縦幅の数値を渡します