Difference between revisions of "love.graphics.clear (日本語)"

m (Add example.)
m
Line 1: Line 1:
LÖVE [[0.9.2]] 以前では[[love.graphics.setBackgroundColor (日本語)|背景色]]で、または [[0.10.0]] 以降では指定された色で画面を消去します。
+
画面または有効な [[Canvas (日本語)|Canvas]] を指定色で消去します。
  
この関数は [[love.draw (日本語)|love.draw]] の前に標準の [[love.run (日本語)|love.run]] 関数から自動的に呼ばれます。この関数の典型的な使用法については [[love.run (日本語)|love.run]] の用例を参照してください。
+
この関数は [[love.draw (日本語)|love.draw]] よりも前にあるデフォルトの [[love.run (日本語)|love.run]] 関数から自動的に呼ばれます。この関数の典型的な用法は [[love.run (日本語)|love.run]] の用例を参照してください。
  
 
注意点として消去の領域は[[love.graphics.setScissor (日本語)|切り抜き範囲]]において制限されます。
 
注意点として消去の領域は[[love.graphics.setScissor (日本語)|切り抜き範囲]]において制限されます。
 +
 +
バージョン [[11.0 (日本語)|11.0]] 以前まで、配色成分における値の範囲は小数値の 0 〜 1 ではなく整数値の 0 〜 255 です。
 +
 +
この関数は [[0.10.0 (日本語)|0.10.0]] 以前では、現在設定されている[[love.graphics.setBackgroundColor (日本語)|背景色]]で画面を消去します。
  
 
== 関数 ==
 
== 関数 ==
Line 17: Line 21:
  
 
== 関連 ==
 
== 関連 ==
{{newin (日本語)|[[0.10.0]]|100|type=異形}}
+
{{newin (日本語)|[[0.10.0 (日本語)|0.10.0]]|100|type=異形}}
 
画面または有効な [[Canvas (日本語)|Canvas]] を指定された色で消去します。
 
画面または有効な [[Canvas (日本語)|Canvas]] を指定された色で消去します。
 
=== 概要 ===
 
=== 概要 ===
 
<source lang="lua">
 
<source lang="lua">
love.graphics.clear( r, g, b, a )
+
love.graphics.clear( r, g, b, a, clearstencil, cleardepth )
 
</source>
 
</source>
 
=== 引数 ===
 
=== 引数 ===
Line 27: Line 31:
 
{{param|number|g|画面の消去に使用する緑チャンネルの色です。}}
 
{{param|number|g|画面の消去に使用する緑チャンネルの色です。}}
 
{{param|number|b|画面の消去に使用する青チャンネルの色です。}}
 
{{param|number|b|画面の消去に使用する青チャンネルの色です。}}
{{param|number|a (255)|画面の消去に使用する透過チャンネルの色です。}}
+
{{param|number|a (1)|画面の消去に使用する透過チャンネルの色です。}}
 +
{{New feature (日本語)|11.0|
 +
{{param|boolean|clearstencil (true)|[[love.graphics.setCanvas (日本語)|Canvas]] がある場合、有効なステンシルバッファを消去するかどうか。なお、ステンシルバッファを消去するには 0 ~ 255 までの整数値を指定します。}}
 +
{{param|boolean|cleardepth (true)|[[love.graphics.setCanvas (日本語)|Canvas]] がある場合、有効な深度バッファを消去するかどうか。なお、深度バッファを消去するには 0 ~ 1 までの値を指定します。}}
 +
}}
  
 
=== 返値 ===
 
=== 返値 ===
Line 33: Line 41:
  
 
== 関数 ==
 
== 関数 ==
{{newin (日本語)|[[0.10.0]]|100|type=異形}}
+
{{newin (日本語)|[[0.10.0 (日本語)|0.10.0]]|100|type=異形}}
 
複数の [[Canvas (日本語)|Canvas]] が [[love.graphics.setCanvas (日本語)|love.graphics.setCanvas]] により同時に有効な場合は、複数の有効な  [[Canvas (日本語)|Canvas]] を異なる色で消去します。
 
複数の [[Canvas (日本語)|Canvas]] が [[love.graphics.setCanvas (日本語)|love.graphics.setCanvas]] により同時に有効な場合は、複数の有効な  [[Canvas (日本語)|Canvas]] を異なる色で消去します。
 
=== 概要 ===
 
=== 概要 ===
Line 42: Line 50:
 
{{param|table|color|最初に有効な Canvas の消去に使用する色を <code>{r, g, b, a}</code> 形式で有するテーブル。}}
 
{{param|table|color|最初に有効な Canvas の消去に使用する色を <code>{r, g, b, a}</code> 形式で有するテーブル。}}
 
{{param|table|...|有効な各 Canvas に対する追加のテーブル。}}
 
{{param|table|...|有効な各 Canvas に対する追加のテーブル。}}
 +
{{New feature (日本語)|11.0|
 +
{{param|boolean|clearstencil (true)|[[love.graphics.setCanvas (日本語)|Canvas]] がある場合、有効なステンシルバッファを消去するかどうか。なお、ステンシルバッファを消去するには 0 ~ 255 までの整数値を指定します。}}
 +
{{param|boolean|cleardepth (true)|[[love.graphics.setCanvas (日本語)|Canvas]] がある場合、有効な深度バッファを消去するかどうか。なお、深度バッファを消去するには 0 ~ 1 までの値を指定します。}}}}
 +
}}
 +
 
=== 返値 ===
 
=== 返値 ===
 
ありません。
 
ありません。
 
=== 注釈 ===
 
=== 注釈 ===
この関数における異形を使用するときは、有効な Canvas ごとに色を指定する必要があります。
+
この関数の異形を使用するときは、有効な Canvas ごとに色を指定する必要があります。
 +
 
 +
== 関数 ==
 +
{{newin (日本語)|[[11.0 (日本語)|11.0]]|110|type=異形}}
 +
Clears the stencil or depth buffers without having to clear the color canvas as well.
 +
 
 +
=== 概要 ===
 +
<source lang="lua">
 +
love.graphics.clear( clearcolor, clearstencil, cleardepth )
 +
</source>
 +
 +
=== 引数 ===
 +
{{param|boolean|clearcolor|有効な Canvas を透過付き黒色 (<code>0, 0, 0, 0</code>)で消去するかどうか。一般に、この関数の当異形には false を設定してください。}}
 +
{{param|boolean|clearstencil (true)|[[love.graphics.setCanvas (日本語)|Canvas]] がある場合、有効なステンシルバッファを消去するかどうか。なお、ステンシルバッファを消去するには 0 ~ 255 までの整数値を指定します。}}
 +
{{param|boolean|cleardepth (true)|[[love.graphics.setCanvas (日本語)|Canvas]] がある場合、有効な深度バッファを消去するかどうか。なお、深度バッファを消去するには 0 ~ 1 までの値を指定します。}}
 +
 
 +
=== 返値 ===
 +
ありません。
  
 
== 用例 ==
 
== 用例 ==
 
=== 描画前に Canvas を消去します ===
 
=== 描画前に Canvas を消去します ===
c キーが押された場合は、画面上に新しい線を描画する前にキャンバスは消去されます。
+
c キーを押すと、画面上に新しい線を描画する前にキャンバスを消去します。
 
<source lang="lua">
 
<source lang="lua">
 
local canvas = love.graphics.newCanvas()
 
local canvas = love.graphics.newCanvas()
Line 65: Line 95:
 
         love.graphics.setColor( love.math.random( 255 ), 0, 0 )
 
         love.graphics.setColor( love.math.random( 255 ), 0, 0 )
 
         love.graphics.line( 0, 0, rx, ry )
 
         love.graphics.line( 0, 0, rx, ry )
         love.graphics.setColor( 255, 255, 255 )
+
         love.graphics.setColor( 1, 1, 1)
 
     end)
 
     end)
 
end
 
end
Line 88: Line 118:
 
[[Category:Functions]]
 
[[Category:Functions]]
 
[[Sub-Category::Drawing (日本語)| ]]
 
[[Sub-Category::Drawing (日本語)| ]]
{{#set:Description=背景色または指定色にて画面を消去します。}}
+
{{#set:Description=画面または有効な [[Canvas (日本語)|Canvas]] を指定色で消去します。}}
 
{{#set:Since=000}}
 
{{#set:Since=000}}
 
== そのほかの言語 ==
 
== そのほかの言語 ==
{{i18n|love.graphics.clear}}
+
{{i18n (日本語)|love.graphics.clear}}

Revision as of 01:36, 5 July 2019

画面または有効な Canvas を指定色で消去します。

この関数は love.draw よりも前にあるデフォルトの love.run 関数から自動的に呼ばれます。この関数の典型的な用法は love.run の用例を参照してください。

注意点として消去の領域は切り抜き範囲において制限されます。

バージョン 11.0 以前まで、配色成分における値の範囲は小数値の 0 〜 1 ではなく整数値の 0 〜 255 です。

この関数は 0.10.0 以前では、現在設定されている背景色で画面を消去します。

関数

0.9.2 以前では背景色、または LÖVE 0.10.0 以降では透過付き黒色 (0, 0, 0, 0) にて画面を消去します。

概要

love.graphics.clear( )

引数

なし。

返値

ありません。

関連

LÖVE 0.10.0 から使用可能
この異形は以前のバージョンでは非対応です。

画面または有効な Canvas を指定された色で消去します。

概要

love.graphics.clear( r, g, b, a, clearstencil, cleardepth )

引数

number r
画面の消去に使用する赤チャンネルの色です。
number g
画面の消去に使用する緑チャンネルの色です。
number b
画面の消去に使用する青チャンネルの色です。
number a (1)
画面の消去に使用する透過チャンネルの色です。
LÖVE 11.0 から利用可能
boolean clearstencil (true)
Canvas がある場合、有効なステンシルバッファを消去するかどうか。なお、ステンシルバッファを消去するには 0 ~ 255 までの整数値を指定します。
boolean cleardepth (true)
Canvas がある場合、有効な深度バッファを消去するかどうか。なお、深度バッファを消去するには 0 ~ 1 までの値を指定します。


返値

ありません。

関数

LÖVE 0.10.0 から使用可能
この異形は以前のバージョンでは非対応です。

複数の Canvaslove.graphics.setCanvas により同時に有効な場合は、複数の有効な Canvas を異なる色で消去します。

概要

love.graphics.clear( color, ... )

引数

table color
最初に有効な Canvas の消去に使用する色を {r, g, b, a} 形式で有するテーブル。
table ...
有効な各 Canvas に対する追加のテーブル。
LÖVE 11.0 から利用可能
boolean clearstencil (true)
Canvas がある場合、有効なステンシルバッファを消去するかどうか。なお、ステンシルバッファを消去するには 0 ~ 255 までの整数値を指定します。
boolean cleardepth (true)
Canvas がある場合、有効な深度バッファを消去するかどうか。なお、深度バッファを消去するには 0 ~ 1 までの値を指定します。

}}

返値

ありません。

注釈

この関数の異形を使用するときは、有効な Canvas ごとに色を指定する必要があります。

関数

LÖVE 11.0 から使用可能
この異形は以前のバージョンでは非対応です。

Clears the stencil or depth buffers without having to clear the color canvas as well.

概要

love.graphics.clear( clearcolor, clearstencil, cleardepth )

引数

boolean clearcolor
有効な Canvas を透過付き黒色 (0, 0, 0, 0)で消去するかどうか。一般に、この関数の当異形には false を設定してください。
boolean clearstencil (true)
Canvas がある場合、有効なステンシルバッファを消去するかどうか。なお、ステンシルバッファを消去するには 0 ~ 255 までの整数値を指定します。
boolean cleardepth (true)
Canvas がある場合、有効な深度バッファを消去するかどうか。なお、深度バッファを消去するには 0 ~ 1 までの値を指定します。

返値

ありません。

用例

描画前に Canvas を消去します

c キーを押すと、画面上に新しい線を描画する前にキャンバスを消去します。

local canvas = love.graphics.newCanvas()
local clear

function love.update()
    -- Canvas の線を描画するために無名関数を使用します。
    canvas:renderTo( function()
        if clear then
            love.graphics.clear() -- 線を描画する前に Canvas を消去します
        end

        -- 画面の原点から無作為に x および y 座標に対して線を描画します。
        local rx, ry = love.math.random( 0, love.graphics.getWidth() ), love.math.random( 0, love.graphics.getHeight() )
        love.graphics.setColor( love.math.random( 255 ), 0, 0 )
        love.graphics.line( 0, 0, rx, ry )
        love.graphics.setColor( 1, 1, 1)
    end)
end

function love.draw()
    love.graphics.draw( canvas )
end

function love.keypressed( key )
    if key == "c" then
        clear = not clear
    end
end

関連


そのほかの言語