Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

粒子著色器

粒子著色器是一種特殊的著色器,它會在物體實際繪製之前執行。它的作用是計算各種材質屬性,比如顏色、位置和旋轉角度。至於最終的繪製效果,則可以使用任何常規的 CanvasItem(畫布項)或 Spatial(空間)材質來呈現,具體取決於你的粒子是 2D 還是 3D 的。

粒子著色器很特別,因為它們不是用來繪製物件本身,而是用來計算粒子的屬性,這些屬性會被 CanvasItem 或 Spatial 著色器使用。粒子著色器包含兩個處理函式:start() 和 process()。

與其他著色器類型不同,粒子著色器會保留上一幀輸出的資料。因此,粒子著色器能用來實現需跨多幀運算的複雜特效。

備註

粒子著色器僅能搭配 GPU 型粒子節點(GPUParticles2D 與 GPUParticles3D)使用。

CPU 型粒子節點(CPUParticles2D 與 CPUParticles3D)會在 GPU 上進行算繪(可使用自訂 CanvasItem 或 Spatial 著色器),但其運動是在 CPU 上模擬的。

算繪模式

算繪模式

說明

keep_data

重新啟動時不清除先前的資料。

disable_force

停用吸引力。

disable_velocity

忽略 VELOCITY 值。

collision_use_scale

於碰撞時套用粒子的縮放大小。

內建變數

標記為 in 的值為唯讀。標記為 out 的值可以選擇寫入,且不一定包含合理的預設值。標記為 inout 的值則有預設值,可以選擇寫入。取樣器(sampler)無法寫入,因此未標註。

全域內建變數

全域內建變數可於任何地方使用,包括自訂函式中。

內建變數

說明

in float TIME

自引擎啟動以來的全域時間,以秒為單位。它每經過 3,600 秒就會重設循環一次(這個時長可以通過 rollover 設定來修改)。它受 time_scale (時間縮放/遊戲速度)的影響,但不受暫停(pausing)的影響。如果你需要一個不受 time_scale 影響的 TIME 變數,可以新增你自己的 global shader uniform ,並在每一影格更新它。

in float PI

常數 PI (值為 3.141592 )。它是圓的周長與直徑的比值,也是轉半圈(180度)所包含的弧度數。

in float TAU

常數 TAU (值為 6.283185 )。它等同於 PI * 2 ,也就是一個完整圓周(整圈)所包含的弧度數。

in float E

常數 E (值為 2.718281 )。即歐拉數,自然對數的底數。

Start 與 Process 內建變數

這些屬性可於 start() 與 process() 兩個函式中存取。

當使用內建的 ParticleProcessMaterial 時, USERDATA1 在該內建模組中被定義為以下值:

  • w:由角速度(以弧度為單位)累積而成的角度,由角速度紋理應用。

函式

說明

in float LIFETIME

粒子的存活時間。

in float DELTA

每幀處理的時間差。

in uint NUMBER

自發射開始以來的唯一編號。

in uint INDEX

粒子索引(來自所有粒子編號)。

in mat4 EMISSION_TRANSFORM

發射器的變換(用於非本地座標系統)。

in uint RANDOM_SEED

隨機數種子,用作生成隨機數的基礎。

inout bool ACTIVE

當粒子處於活躍(啟用)狀態時,它的值為 true ;你可以將其設定為 false 。

inout vec4 COLOR

粒子顏色,支援寫入資料,並且可以在網格(mesh)的頂點函式中存取。

inout vec3 VELOCITY

粒子的速度,可修改。

inout mat4 TRANSFORM

粒子的變換。

inout vec4 CUSTOM

自訂粒子資料。可以在網格(mesh)的著色器中通過 INSTANCE_CUSTOM 來存取。

inout float MASS

粒子質量,通常用於配合吸引器(attractors)使用。預設值為 1.0 。

in vec4 USERDATAX

可將額外的自訂資料整合進入粒子處理著色器的向量。USERDATAX 有六個內建變數,以數字區分,X 可為 1 到 6,例如 USERDATA3。

in uint FLAG_EMIT_POSITION

這是 emit_subparticle() 函式最後一個參數的一個標誌,用於給新粒子的變換(transform)分配一個自訂位置。

in uint FLAG_EMIT_ROT_SCALE

這是 emit_subparticle() 函式最後一個參數的一個標誌,用於給新粒子的變換(transform)分配自訂的旋轉和縮放。

in uint FLAG_EMIT_VELOCITY

這是 emit_subparticle() 函式最後一個參數的一個標誌,用於給新粒子分配一個自訂速度。

in uint FLAG_EMIT_COLOR

這是 emit_subparticle() 函式最後一個參數的一個標誌,用於給新粒子分配一個自訂顏色。

in uint FLAG_EMIT_CUSTOM

這是 emit_subparticle() 函式最後一個參數的一個標誌,用於給新粒子分配一個自訂資料向量。

in vec3 EMITTER_VELOCITY

Particles2D 或 Particles3D 節點的發射器速度。

in float INTERPOLATE_TO_END

Particles(粒子)節點的 interp_to_end (3D) 屬性的值。

in uint AMOUNT_RATIO

Particles(粒子)節點的 amount_ratio (3D)屬性的值。

備註

若要在 StandardMaterial3D 中使用 COLOR 變數,請將 vertex_color_use_as_albedo 設為 true。在 ShaderMaterial 中,直接以 COLOR 變數存取。

Start 內建變數

內建變數

說明

in bool RESTART_POSITION

若粒子被重新啟動,或未指定自訂位置時(即這個粒子是由 emit_subparticle() 且未帶 FLAG_EMIT_POSITION 旗標產生),則為 true。

in bool RESTART_ROT_SCALE

若粒子被重新啟動,或未指定自訂旋轉/縮放時(即這個粒子是由 emit_subparticle() 且未帶 FLAG_EMIT_ROT_SCALE 旗標產生),則為 true。

in bool RESTART_VELOCITY

若粒子被重新啟動,或未指定自訂速度時(即這個粒子是由 emit_subparticle() 且未帶 FLAG_EMIT_VELOCITY 旗標產生),則為 true。

in bool RESTART_COLOR

若粒子被重新啟動,或未指定自訂顏色時(即這個粒子是由 emit_subparticle() 且未帶 FLAG_EMIT_COLOR 旗標產生),則為 true。

in bool RESTART_CUSTOM

若粒子被重新啟動,或未指定自訂屬性時(即這個粒子是由 emit_subparticle() 且未帶 FLAG_EMIT_CUSTOM 旗標產生),則為 true。

Process 內建變數

內建變數

說明

in bool RESTART

如果目前處理的這一影格是該粒子的第一影格,則回傳 true (真)。

in bool COLLIDED

當粒子與碰撞器發生碰撞時為 true。

in vec3 COLLISION_NORMAL

上一次碰撞的法線。如果沒有偵測到碰撞,則為 (0.0, 0.0, 0.0)。

in float COLLISION_DEPTH

最後一次碰撞的法線長度。如果沒有檢測到碰撞,則該值等於 0.0 。

in vec3 ATTRACTOR_FORCE

該粒子當前受到的所有吸引器合力。

Process 函式

目前, emit_subparticle() 是粒子著色器中唯一支援的自訂函式。它允許使用者通過子發射器,按照指定的參數來生成一個新的粒子。這個新生成的粒子只會應用與 flags 參數相匹配的那些屬性。例如,下面的程式碼會發射一個帶有指定位置、速度和顏色的粒子,但不會指定它的旋轉、縮放以及自訂數值。

mat4 custom_transform = mat4(1.0);
custom_transform[3].xyz = vec3(10.5, 0.0, 4.0);
emit_subparticle(custom_transform, vec3(1.0, 0.5, 1.0), vec4(1.0, 0.0, 0.0, 1.0), vec4(1.0), FLAG_EMIT_POSITION | FLAG_EMIT_VELOCITY | FLAG_EMIT_COLOR);

函式

說明

bool emit_subparticle (mat4 xform, vec3 velocity, vec4 color, vec4 custom, uint flags)

從子發射器發射一個粒子。