love.window.updateMode (日本語)
LÖVE 11.0 から使用可能 |
この関数は以前のバージョンでは非対応です。 |
未指定のプロパティを変更せずにディスプレイモードとウィンドウのを設定します。
width または height が 0 ならば updateMode はデスクトップの幅と高さを使用します。
ディスプレイモードの変更には副作用があります: 例えば、 キャンバスは消去されます。事前にキャンバスの内容を保存してあるか確認するか、または必要ならば処理後に再描画してください。
関数
概要
success = love.window.updateMode( width, height, settings )
引数
number width
- ウィンドウの幅。
number height
- ウィンドウの高さ。
table settings
- 下記のオプションのフィールドから成る設定用テーブルです。未指定のフィールドについては love.window.getMode から返された現在値を使用します。
boolean fullscreen
- フルスクリーン (true), またはウィンドウ (false)。
FullscreenType fullscreentype
- 使用するフルスクリーンモードの種類。
boolean vsync
- True ならば LÖVE は vsync (垂直同期) 待ちを行いますが、それ以外は false です。
number msaa
- アンチエイリアスのサンプル数。
boolean resizable
- True ならばウィンドウ表示状態でウィンドウの大きさを変更できるようにしますが、それ以外は false です。
boolean borderless
- True ならばウィンドウ表示状態でボーダーレスウィンドウ (外枠なし表示) にしますが、それ以外は false です。
boolean centered
- True ならばウィンドウ表示状態でウィンドウを画面中央に表示にしますが、それ以外は false です。
number display
- マルチモニターが利用可能ならば、ウィンドウが表示されているディスプレイの識別番号。
number minwidth
- サイズ変更可能ならば、ウィンドウの最小の幅。 1 未満は指定できません。
number minheight
- サイズ変更可能ならば、ウィンドウの最大の高さ。 1 未満は指定できません。
boolean highdpi
- true ならば high-dpi 方式は macOS および iOS で Retina ディスプレイで許可されています。これは非-Retina ディスプレイでは関係ありません。
number x
- 指定されたディスプレイにおけるウィンドウの x 座標位置。
number y
- 指定されたディスプレイにおけるウィンドウの y 座標位置。
返値
boolean success
- true ならば成功、それ以外は false です。
Notes
フルスクリーンが有効になったが非対応の幅または高さである場合 (love.window.getFullscreenModes を参照)、ウィンドウは最も近くて利用可能な解像度へサイズ変更されて resize イベントが発生します。
フルスクリーンの種類が "desktop" ならば、ウィンドウの大きさは自動的にデスクトップの解像度と同じ値へ変更されます。
現在のところ背景の透過には対応していません。
関連
- love.window (日本語)
- love.window.setMode (日本語)
- love.window.getMode (日本語)
- love.window.getFullscreenModes (日本語)
- love.resize (日本語)