この記事はMinecraft Java Edition版 26.3向けの記事です。
また、リソースパック制作の際の最低限の知識が前提となります。
(pack_formatの書き方や、ファイル、フォルダ作成など)
はじめに
前回の記事では、Minecraftのシェーダーについて
- JSON
- VSH
- FSH
がそれぞれどのような役割を持っているのかを説明しました。
まだ読んでいない方は、先にこちらを読むことをおすすめします。
今回は、その中でもJSONに焦点を当てていきます。
JSON自体の書き方については、データパックやリソースパックを触ったことがある方なら、ある程度分かると思います。
そのため今回は、この項目を設定するとシェーダーのどこで何が起こるのかという視点で見ていきます。
特に今回重要なのがuniformsです。
JSONからVSH・FSHへどのように値を渡しているのかを、実際のMinecraftのアセットを見ながら確認していきます。
また、この記事はpost_effectのJSONのフォーマットをすべて解説しているわけではありません。実際のJSONを元に最低限の解説をしています。もしすべてのフォーマットを知りたい場合はこちらをご覧ください。
1. 実際のJSONを見てみよう!
まずは、実際にMinecraftで使われているポストエフェクトのJSONを見てみましょう。
今回はMinecraftに用意されているinvert.jsonを例にします。
invertは、画面の色を反転させるポストエフェクトです。
26.3のアセットでは、次のようになっています。
{
"targets": {
"swap": {}
},
"passes": [
{
"vertex_shader": "minecraft:core/screenquad",
"fragment_shader": "minecraft:post/invert",
"inputs": [
{
"sampler_name": "In",
"target": "minecraft:main"
}
],
"output": "swap",
"uniforms": {
"InvertConfig": [
{
"name": "InverseAmount",
"type": "float",
"value": 0.8
}
]
}
},
{
"vertex_shader": "minecraft:core/screenquad",
"fragment_shader": "minecraft:post/blit",
"inputs": [
{
"sampler_name": "In",
"target": "swap"
}
],
"uniforms": {
"BlitConfig": [
{
"name": "ColorModulate",
"type": "vec4",
"value": [ 1.0, 1.0, 1.0, 1.0 ]
}
]
},
"output": "minecraft:main"
}
]
}
実際のMinecraftのアセットは、MC Assetsから確認できます。
一見すると項目が多くて少し難しく見えます。
しかし、役割ごとに分けてみると、それほど複雑ではありません、
大まかに見ると、
json
│
├─ targets
│ └─途中結果を保存する場所
│
└─ passes
│
├─ vertex_shader
├─ fragment_shader
├─ inputs
├─ uniforms
└─ output
という構造になっています。
では、それぞれ何をしているのでしょうか?
2. targets : シェーダーの結果を保存する場所
まずはこちらです。
"targets":{
"swap": {}
}
targetsは、ポストエフェクトの途中結果などを保存するためのレンダーターゲットを定義する場所です。
今回の例では、swapというターゲットを作っています。
それでは、なぜわざわざ一時保存する必要があるのでしょうか?
それは、今回のinvert.jsonが2つの処理を順番に行っているからです。
3. passes : シェーダー処理を1つずつ実行する
次は、passesです。
"passes": [
...
]
passesは、どのシェーダー処理を、どの順番で実行するのかを定義します。
今回のinvert.jsonでは2つのpassがあります。
Pass 1
Minecraftの画面
↓
色を反転する
↓
swapに保存
pass 2
swap
↓
色味を調整
↓
Minecraftの画面
という流れです。
passesの中にある{ ... }が、一回分のシェーダー処理だと考えるとわかりやすいと思います。
4. vertex_shaderとfragment_shader
それぞれのpassの中を見ると、まずこの2つがあります。
"vertex_shader": "minecraft:core/screenquad"
"fragment_shader": "minecraft:post/invert"
ここでは、
-
vertex_shader使用するVSH -
fragment_shader使用するFSH
を指定しています。
5. inputs : FSHなどに画像を渡す
次に、
"inputs": [
{
"sampler_name": "In",
"target": "minecraft:main"
}
]
を見てみましょう。
これは、 「シェーダーにどの画像を入力として渡すのか」 を指定しています。
今回の場合、
"target": "minecraft:main"
となっています。
これは、Minecraftのメイン画面を入力として使用するという意味です。
そして、
"sampler_name": "In"
によって、その入力をシェーダー側でどの名前から扱うのか指定しています。
実際にFSH側の一部を見てみましょう
uniform sampler2D InSampler;
ここで、InSamplerという名前の画像を扱えるようになっています。
このあたりは次回以降、FSHを詳しく扱う時に改めて説明します。
ここで注意したいのは、JSON側で
"sampler_name": "In"と指定すると、Minecraftの仕様により末尾にSamplerが自動補完されます。
そのため、FSH側ではInではなくInSamplerという変数名で画像を受け取ることになります。
・JSON側:"sampler_name": "In"
・FSH側:uniform sampler2D Insampler
自分で新しい入力名を決める場合も、FSH側では必ず末尾にSamplerを付けた変数名で呼び出す必要があります。
6. output : 処理結果をどこへ出すのか
次はこちらです。
"output": "swap"
これは、 このpassで処理した結果を、どこに出力するのか を指定しています。
今回の場合は、
入力
minecraft:main
↓
invert.fsh
↓
出力
swap
となります。
そのため、
"output": "swap"
の次のpassでは、
"target": "swap"
として、先ほどの結果を入力に使っています。
7. targets・inputs・outputのまとめ
ということで、ここまでの内容を一旦整理してみましょう。
今回の1つ目のpassでは、
"inputs": [
{
"sampler_name": "In",
"target": "minecraft:main"
}
]
"output": "swap"
となっています。
これを図にすると、
となります。
そして2つ目のpassでは、
となります。
このように、
-
targets→ 保存場所を用意する -
inputs→ 何を入力するか -
output→ 結果をどこへ出すか -
passes→ それらをどの順番で処理するか
という関係になっています。
targetsとtargetを間違えないように
8. 今回のメインuniforms
ここからが、今回の重要なところです。
invert.jsonの中には、このような部分があります。
"uniforms": {
"InvertConfig": [
{
"name": "InverseAmount",
"type": "float",
"value": 0.8
}
]
}
uniformsは、シェーダーで使用する値を設定するための項目です。
今回の場合、
"value": 0.8
という値を設定しています。
実際のinvert.fshには、
layout(std140) uniform InvertConfig {
float InverseAmount;
};
というuniform blockがあります。
そして、この値を使って、
vec4 outColor = mix(diffuseColor, invertColor, InverseAmount);
のように処理しています。
つまり、
という関係になっています。
uniform blockとは?
シェーダー側で、複数のuniformをひとまとめにして扱うための仕組みです。
Minecraftのシェーダーでは、JSONのuniformsにある"InvertConfig"のような名前が、シェーダー側のuniform blockに対応します。
uniformsの構造
ここで、JSONのこの部分をもう一度見てみましょう。
"uniforms": {
"InvertConfig": [
{
"name": "InverseAmount",
"type": "float",
"value": 0.8
}
]
}
まず、
"InvertConfig": [
のInvertConfigがuniform blockの名前です。
FSH側にも、
uniform InvertConfig {
...
};
というblockがあります。
その中に、
{
"name": "InverseAmount",
"type": "float",
"value": 0.8
}
という値を定義しています。
ここで注意したいのがnameです。
"name": "InverseAmount"
と書かれていますが、このnameはゲーム側では使用されません
JSONを読んだときに、「これは何の値なのか?」がわかりやすくなるように、整理・管理のために名前を付けているものです。
そのため、nameとシェーダー側の変数名がゲームによって直接結びつけられるわけではありません。
typeとvalue
次に、
"type": "float"
"value": 0.8
です。
typeは、渡す値の種類を指定します。
例えば、
"type": "float"
なら単精度浮動小数点数を扱います。
ほかにも、int vec2 vec3 ivec3 vec4 matrix4x4などがあります。
そして、
"value": 0.8
が実際に渡す値です。
例えばvec4なら
{
"name": "ColorModulate",
"type": "vec4",
"value": [1.0, 1.0, 1.0, 1.0]
}
のように4つの値を指定します。
このように、
-
type= どんな種類の値なのか -
value= 実際に渡す値
と考えるとわかりやすいです。
もう一つ、uniformsで重要なのが値の順番です。
26.3では、uniformはblockごとに定義されます。
例えば、
"uniforms": {
"ExampleConfig": [
{
"name": "ValueA",
"type": "float",
"value": 0.5
},
{
"name": "ValueB",
"type": "float",
"value": 1.0
}
]
}
とした場合、シェーダー側でも対応するuniform block内の順番を合わせる必要があります。
layout(std140) uniform ExampleConfig {
float ValueA;
float ValueB;
};
というように、 名前ではなく並び順が重要になる ことです。
そのため、JSON側とシェーダー側で型や順番が合っていないと、意図しない動作につながります。
uniformsは「JSONに適当に値を書けばシェーダー側の好きな変数に入る」というものではありません。
uniform blockの構造や値の順番、型などをシェーダー側と合わせる必要があります。
この部分は、今後VSH・FSHを書くうえでも重要になってきます。
9. JSONとVSH・FSHの関係
ここまでの内容を一度整理してみます。
ポストエフェクトのJSONは、大きく見ると次のような役割をしています。
という流れです。
第1回で、
「JSON = 指示書・司令塔」
と説明しました。
今回、実際のJSONを見ることで、その指示が何なのかが少し見えてきたと思います。
10. 実際のMinecraftのJSONを調べてみよう
ここまで理解できたら、実際のMinecraftのアセットを自分で見てみることをおすすめします。
おすすめが、最初に少し説明したMC Assetsです。
26.3のアセットをブラウザから確認することができます。
シェーダー関連までは、
assets
└─ minecraft
├─ post_effect
└─ shaders
├─ core
├─ post
└─ include
などを見ることができます。
例えば、post_effectの中にあるJSONを見て、
このJSONは何個のPassを使っている?
↓
どのVSHを使っている?
↓
どのFSHを使っている?
↓
何を入力している?
↓
どんなuniformを渡している?
↓
どこへ出力している?
という順番で追ってみると、かなり読みやすくなります。
さらに、指定されているFSHを開いてみれば、JSONで設定した値が、シェーダー側でどのように使われているかまで確認できます。
バージョンが変わると、シェーダーやJSONの使用が変更される可能性があります。
そのため、古い記事だけを参考にするのではなく、自分が使っているバージョンのアセットを実際に確認することをおすすめします。
11. JSONを読むときは「何を指定しているのか」を見る
最後に、今後のJSONを見るときの考え方をまとめておきます。
初めて見るJSONをすべて理解しようとすると大変なので、まずは次の順番で見てみてください。
"targets": {
"swap": {}
}
"passes": [
...
]
"vertex_shader": "...",
"fragment_shader": "..."
"inputs": [
...
]
"uniforms": {
...
}
"output": "..."
この順番で確認していけば、知らないJSONでも少しずつ構造が見えてくるとはずです。
12. まとめ & 次回予告
今回は、ポストエフェクトで使用されるJSONについて詳しく見ていきました。
今回登場した項目をまとめると、
| 項目 | 主な役割 |
|---|---|
targets |
処理結果を保存するレンダーターゲットを定義 |
passes |
シェーダー処理を順番に定義 |
vertex_shader |
使用するVSHを指定 |
fragment_shader |
使用するFSHを指定 |
inputs |
シェーダーへ入力するものを指定 |
uniforms |
シェーダーへ渡す値を指定 |
output |
処理結果の出力先を指定 |
そして、今回特に覚えておいてほしいのがuniformsです。
JSON
│
│ uniforms
↓
uniform block
│
↓
VSH / FSH
という形で、JSONからシェーダーへ値を渡すことができます。
また、26.3ではuniform block単位で扱われており、block内の値はシェーダー側との順番や型を合わせる必要があります。
ただし、今回の記事ではまだ、
layout(std140) uniform InvertConfig {
float InverseAmount;
};
のようなシェーダー側のコードについては、詳しく説明していません。
次回からはいよいよVSHやFSHそのものを見ていきます。
次回(第3回)は、「VSHのコードの見方」 について、実際のコードを見ながら詳しく解説していきます。