SpriteKit で Shader が放置プレイされるとおかしくなる件

#u_time の使い方に注意！
iOS 8 では SpriteKit が更に強化され、これでサードパーティ製のライブラリ（Cocos2D など）を導入しなくてもネイティブだけで Fragment Shader まで普通に使えるようになり、大変助かるのです。ところが、この Shader ですが、SpriteKit の問題なのかなんのかよくわかりませんが、物によっては長く放置してしまうとレンダリングが徐々におかしくなっていくこともしばしばあります。まあ結論から言うとこの章のタイトル通り、「u_time」の使い方には注意してほしいということですが、何の話なんかさっぱりわからない読者も居ると思いますのでとりあえず順を追ってまず SpriteKit でアプリを作るところから説明します。もうわかってるよとりあえず Shader をどう直せばいいのかが知りたい読者は直接「u_time を直す」の章へGO👉
ちなみに、「u_time を直す」までの部分は単純に[こちらの動画](https://www.youtube.com/watch?v=rd7pEru73IY)をわかりやすく日本語に直しただけなので、英語でも問題ないよという方ならその動画でそのまま進めてみましょう！

#SpriteKit を導入
それじゃあまず SpriteKit でのアプリの作り方から始めましょう。まず Xcode 開いて、新規プロジェクトつくって、プロジェクトテープレートはゲームにします
![スクリーンショット 2015-06-03 15.59.05.png](https://qiita-image-store.s3.amazonaws.com/0/63998/05d01242-6b29-5216-499a-de9fa5ba5aae.png)

次に適当に名前つけて、Game Technology は SpriteKit にして、言語は Objective-C でもいいんですがとりあえずここは Swift にして、あとは作成
![スクリーンショット 2015-06-03 16.00.57.png](https://qiita-image-store.s3.amazonaws.com/0/63998/e394ae56-0349-0d70-97dc-cb14cc051bd0.png)

そうするととりあえず最初のテンプレートアプリが作成されます。いつもの Single View アプリよりだいぶコード量が増えているのがわかると思います
![スクリーンショット 2015-06-03 16.01.33.png](https://qiita-image-store.s3.amazonaws.com/0/63998/4649a9f7-27ce-b5f5-2966-3abd671abc9d.png)

このテンプレートでは SKScene オブジェクトをインターフェイスファイルから作成されることになりますが、まあここではそれ使わないのでとりあえず削除。削除したそれに合わせて `GameViewController` のコードも `if let scene = GameScene`のブロック外して、普通に `let scene = GameScene(size: CGSize(width: 1920, height: 1080))` にしましょう（サイズはまあ自由に自分の好きなサイズで作っちゃいましょう。ここは適当に 1080p にしただけです。
![スクリーンショット 2015-06-03 16.03.23.png](https://qiita-image-store.s3.amazonaws.com/0/63998/481467fd-e893-a734-173d-5e5964307c63.png)

ここまで来たらあと `GameViewController` クラスは特に弄らないので放っておきましょう。次は `GameScene` クラスです。まずテンプレートではすでにいろんなことを設定しておいてくれました。
![スクリーンショット 2015-06-03 16.04.10.png](https://qiita-image-store.s3.amazonaws.com/0/63998/4e2322d7-186e-4432-598f-721c5358e2f8.png)

が、これらも特に使わないので中身全部削除して、適当に「Test.png」の名前で画像をプロジェクトに追加して、`didMoveToView(view: SKView)` メソッドに下記のコードを追加します

```swift
	// SKSpriteNode オブジェクトを作って中身をその Test.png の画像にします
	let node = SKSpriteNode(imageNamed: "Test")
	
	// SKScene の起点はど真ん中ではなく左下なので、それに合わせて node の基準点（アンカーポイント）もそれにします
	node.anchorPoint = CGPoint(x: 0, y: 0)
	
	
	// 画面に追加します
	self.addChild(node)
```

するとこんなふうになります
![スクリーンショット 2015-06-03 16.11.14.png](https://qiita-image-store.s3.amazonaws.com/0/63998/51c0aef1-9719-1286-667a-1d6b7fc46d19.png)

ちなみに Test.png の画像は別になんでもいいんです。例えば筆者の場合は本当にただの真っ赤の画像でした
![スクリーンショット 2015-06-03 16.11.17.png](https://qiita-image-store.s3.amazonaws.com/0/63998/47048813-23bd-8747-7ae9-28290b32f4f1.png)

さあ起動してみましょう、起動するとこのような画面が表示されます
![IMG_0053.jpg](https://qiita-image-store.s3.amazonaws.com/0/63998/ef179ff2-dd2b-3796-7bc4-87f402db7844.jpeg)

これで、SpriteKit で最初のアプリが作れました！

#Shader を入れよう
まず Shader ってなに？という方もいると思いますが…まあぶっちゃけ筆者もそんなに詳しくないのでとりあえず Shader Language で書かれた画面処理のことって OK かな？んでそんな Shader 書いたこともないしわかんないよって方も大丈夫！だって筆者も書いたことないから（おい！）そしてそんな Shader 書けない人のために、便利なサイトが有るんですね、たとえばここ：[ShaderToy](https://www.shadertoy.com/)。今日はとりあえずこの中の [bubbly sines](https://www.shadertoy.com/view/Mdf3zX) というものを作ってみましょう。PC で見るとページの右側に Shader のソースコードがありますので GLSL とかがわからなくても大丈夫だ問題ない！
![スクリーンショット 2015-06-03 17.13.07（2）.png](https://qiita-image-store.s3.amazonaws.com/0/63998/d4144e14-6024-6b4f-7adb-b7eb71fbc225.png)

それでは Xcode に戻って Shader のために新しいファイルを追加しましょう
![スクリーンショット 2015-06-03 16.19.20.png](https://qiita-image-store.s3.amazonaws.com/0/63998/20597412-29de-3c7e-76f0-b0e80fea9a7d.png)

ファイル名はなんでも OK（ここでは BubblySines.fsh にしています）ですが拡張子だけは .fsh が絶対です。（ちなみになぜ fsh かというとおそらく **F**ragment **Sh**ader から来てるかと思います）
![スクリーンショット 2015-06-03 16.24.41.png](https://qiita-image-store.s3.amazonaws.com/0/63998/126b8e03-e755-728c-a890-09f1480a35a1.png)

そして先のページの右側からコードをそのままコピペして保存しましょう
![スクリーンショット 2015-06-03 16.24.52.png](https://qiita-image-store.s3.amazonaws.com/0/63998/bb422ada-b825-445a-bc84-ed6d1a6f6e3b.png)

できましたら次は `GameScene` に戻って、`self.addChild(node)` の前に Shader を入れます。とっても簡単です♪

```swift
	// Shader を BubblySines.fsh ファイルから作ります
	let bubblySines = SKShader(fileNamed: "BubblySines.fsh")
	
	// node に先ほど作った Shader を追加します
	node.shader = bubblySines
```

ね？簡単でしょ？これで Build and Run！って…あれ？画面変わらないぞ？さっきと同じ真っ赤なだけだぞ？？とツッコむあなた、あなたは正しいです！なぜなら、Shader のコードをコピペだけでは使えませんでした＼(^o^)／なんでや！なにが「GLSL とかがわからなくても大丈夫だ問題ない」だ！結局コピペじゃ使えねぇじゃねか！！って思うかもしれませんが、まあまあ大丈夫そんなに難しいことではありませんからもう少し付き合ってくださいな

#SpriteKit 仕様に合わせて Shader コードを修正
まず、SpriteKit で Shader は `#define` は使えませんので、これらを変数宣言に直します。
次に、`void mainImage` 関数もこんな複雑な関数は使えないので、簡潔に `void main()` に直します。
次は定義されていない変数としてソースコードに `iResolution` と `iGlobalTime` がありますが、これらは要するに Shader のサイズと現在の時間を取得しているので、これらは[公式資料](https://developer.apple.com/library/prerelease/ios/documentation/SpriteKit/Reference/SKShader_Ref/index.html)を漁って見ればわかりますがそれぞれ `u_sprite_size` と `u_time` としてすぐに使えますので置き換えます。
最後は `fragCoord` と `fragColor` はそれぞれ `gl_FragCoord` と `gl_FragColor` として定義されているのでこれも置き換えます。というわけで最終的に出来上がったコードは

```glsl
float M_PI = 3.141592653589793;
float M_2PI = 6.283185307179586;

vec3 c1a = vec3(0.0, 0.0, 0.0);
vec3 c1b = vec3(0.9, 0.0, 0.4);
vec3 c2a = vec3(0.0, 0.5, 0.9);
vec3 c2b = vec3(0.0, 0.0, 0.0);

void main()
{
	vec2 p = 2.0*(0.5 * u_sprite_size.xy - gl_FragCoord.xy) / u_sprite_size.xx;
	float angle = atan(p.y, p.x);
	float turn = (angle + M_PI) / M_2PI;
	float radius = sqrt(p.x*p.x + p.y*p.y);
	
	float sine_kf = 19.0;//9.0 * sin(0.1*u_time);
	float ka_wave_rate = 0.94;
	float ka_wave = sin(ka_wave_rate*u_time);
	float sine_ka = 0.35 * ka_wave;
	float sine2_ka = 0.47 * sin(0.87*u_time);
	float turn_t = turn + -0.0*u_time + sine_ka*sin(sine_kf*radius) + sine2_ka*sin(8.0 * angle);
	bool turn_bit = mod(10.0*turn_t, 2.0) < 1.0;
	
	float blend_k = pow((ka_wave + 1.0) * 0.5, 1.0);
	vec3 c;
	if(turn_bit) {
		c = blend_k * c1a + (1.0 -blend_k) * c1b;
	} else {
		c = blend_k * c2a + (1.0 -blend_k) * c2b;
	}
	c *= 1.0 + 1.0*radius;
	
	gl_FragColor = vec4(c, 1.0);
}
```

となります。これでもう一度 Build and Run してみましょう！画面がちゃんと変わるはずです！

#問題点
実はこのコード、シミュレーターなら特に問題ないっぽいのですが、実機では最初のうちは問題なく動きますけどそのままずっと放置すると動きが変になってくるのです（筆者の iPhone 5s と iPhone 6 は両方同じ現象です。OS は iOS 8.3 です）。例えば[この動画のように](http://cl.ly/1g24422N0s2N?_ga=1.75737365.1609599239.1433321496)行って戻ってみたいな感じになってしまいます。わかりづらかったら10分ほど放置してみましょう、違いが明らかに来るはずです

ちなみにこのシェーダーではこうなりますが、物によっては FPS が極端に落ちたように見えたりします。FPS 自体は60のままでかわらないのですが…

そしてなぜこうなってしまうかというと、冒頭で言いました通り、（理由はわかりませんが）u_time のせいなのです。

#u_time を直す
先ほどの Shader のコードへ戻ります。コードを見なおしてみましょう、ここで `u_time` を呼び出しているのは3箇所くらいあります。具体的どういう動きしているのかはわかりませんがもしかするとそれぞれ呼び出しの時にタイムラグが発生してしまうのではないかと筆者が勝手に疑います。というわけでそのまま `u_time` を何度も呼び出すのではなく、一回だけ呼び出して違う変数に格納してみましょう。これで上記のコードがこのようになります：

```glsl
float M_PI = 3.141592653589793;
float M_2PI = 6.283185307179586;

vec3 c1a = vec3(0.0, 0.0, 0.0);
vec3 c1b = vec3(0.9, 0.0, 0.4);
vec3 c2a = vec3(0.0, 0.5, 0.9);
vec3 c2b = vec3(0.0, 0.0, 0.0);

void main()
{
	// u_time の値を time に格納します。
	float time = u_time;
	
	vec2 p = 2.0*(0.5 * u_sprite_size.xy - gl_FragCoord.xy) / u_sprite_size.xx;
	float angle = atan(p.y, p.x);
	float turn = (angle + M_PI) / M_2PI;
	float radius = sqrt(p.x*p.x + p.y*p.y);
	
	float sine_kf = 19.0;//9.0 * sin(0.1*time);
	float ka_wave_rate = 0.94;
	float ka_wave = sin(ka_wave_rate*time);
	float sine_ka = 0.35 * ka_wave;
	float sine2_ka = 0.47 * sin(0.87*time);
	float turn_t = turn + -0.0*time + sine_ka*sin(sine_kf*radius) + sine2_ka*sin(8.0 * angle);
	bool turn_bit = mod(10.0*turn_t, 2.0) < 1.0;
	
	float blend_k = pow((ka_wave + 1.0) * 0.5, 1.0);
	vec3 c;
	if(turn_bit) {
		c = blend_k * c1a + (1.0 -blend_k) * c1b;
	} else {
		c = blend_k * c2a + (1.0 -blend_k) * c2b;
	}
	c *= 1.0 + 1.0*radius;
	
	gl_FragColor = vec4(c, 1.0);
}
```

これでもう一度確認してみましょう、少なくとも筆者の環境では1時間程度放置しても特に変な劣化は見当たりません。
ちなみに、ここではかならず `float time = u_time;` だけにしましょう。変に `float time = u_time * 0.5` とか半分にしたり倍にしたりするのも放置すると時間経過とともに劣化します。一旦 `time` にそのまま格納したらあとで `time` でなにをしようか特に問題ないっぽいですが。

#余談
Shader はすごいよ！というわけで、これから Shader もまじめに扱わないといけなくなってきたからとりあえず OpenGL ES の本を買って読んでみることにしましたけど、環境セットアップから Android が大変そうなのが伝わってきた…やっぱしばらくは iOS オンリーでいいや…
![IMG_0129.jpg](https://qiita-image-store.s3.amazonaws.com/0/63998/b5b3827d-b31d-609c-612e-e88c90b8c361.jpeg)