std::screen::shader

安定性: 暫定 — シェーダーのロール、型付きのシェーダー引数、画面が持つ効果値（フィルター、ミックス、マスク、ペイント、モーション）です。

シェーダーは、レンダラーが GPU で実行する WGSL ファイル（.wgsl）です。シェーダーはどれも 6 つのロールのうち 1 つを持ち、アセット定数の型がロールと引数の型を表します。

use std::screen::shader::{ColorShader, filter};

#[shader_arg]
struct Memory {
    strength: Decimal,
}

const MEMORY: ColorShader<Memory> = asset("memory.wgsl");

シェーダーだけを画面に置くことはありません。このモジュールのコンストラクターがシェーダーと引数を組にして効果値を作り、画面は効果値を持ちます。

コンストラクターはシェーダーの引数型 A の引数を受け取ります。そのため、シェーダーに別の型の引数を渡すことも、あるロールのシェーダーを別のロールの場所で使うこともできません。効果値はフィールドを隠しているので、作る方法はコンストラクターだけです。

効果値は Eq です。同じシェーダーファイルを等しい引数で使う 2 つの効果は等しくなります。効果値は論理画面の一部なので、フィルターの引数だけが違う 2 つの画面は別の画面です。シェーダー型と効果値は有限型ではありません。

std は既製のシェーダーを std::shaders に同梱しています。各ロールのシェーダーの書き方、引数のレイアウト、シェーダーが受け取る時刻は シェーダーの書き方 で説明します。このモジュールのアイテムはプレリュードにありません。use std::screen::shader::… で取り込んでください。

概要

トレイト：ShaderArg

#[builtin] pub trait ShaderArg {}

シェーダーが引数として受け取れる型です。ユニット型 () と、#[shader_arg] を付けたすべての構造体です。実装するのはコンパイラで、ゲームは実装できません。#[shader_arg] 構造体は、引数 に挙げた型の名前付きフィールドを持ちます。

トレイト：Shader

#[builtin] pub trait Shader {}

以下の 6 つのシェーダーアセット型です。

構造体：ColorShader<A>

#[builtin] pub struct ColorShader<A>;
impl<A> Asset for ColorShader<A> {}
impl<A> Eq for ColorShader<A> {}
impl<A> Shader for ColorShader<A> {}

下に描かれたものの色を変える、引数の型が A の WGSL ファイルです。filter で使います。asset("….wgsl") で宣言します。

構造体：MixShader<A>

#[builtin] pub struct MixShader<A>;
impl<A> Asset for MixShader<A> {}
impl<A> Eq for MixShader<A> {}
impl<A> Shader for MixShader<A> {}

エンティティを下にあるものへ合成する WGSL ファイルです。mix で使います。

構造体：TextureShader<A>

#[builtin] pub struct TextureShader<A>;
impl<A> Asset for TextureShader<A> {}
impl<A> Eq for TextureShader<A> {}
impl<A> Shader for TextureShader<A> {}

画像の内容を生成する WGSL ファイルです。paint で使います。

構造体：MaskShader<A>

#[builtin] pub struct MaskShader<A>;
impl<A> Asset for MaskShader<A> {}
impl<A> Eq for MaskShader<A> {}
impl<A> Shader for MaskShader<A> {}

画素ごとのアルファ値を計算する WGSL ファイルです。mask で使います。

構造体：LocalMotionShader<A>

#[builtin] pub struct LocalMotionShader<A>;
impl<A> Asset for LocalMotionShader<A> {}
impl<A> Eq for LocalMotionShader<A> {}
impl<A> Shader for LocalMotionShader<A> {}

エンティティをそのポーズの周りで動かす WGSL ファイルです。local_motion で使います。

構造体：TransitionalMotionShader<A>

#[builtin] pub struct TransitionalMotionShader<A>;
impl<A> Asset for TransitionalMotionShader<A> {}
impl<A> Eq for TransitionalMotionShader<A> {}
impl<A> Shader for TransitionalMotionShader<A> {}

エンティティをあるポーズから別のポーズへ動かす WGSL ファイルです。transitional_motion で使います。

構造体：ShaderArgs

#[builtin] pub struct ShaderArgs;
impl Eq for ShaderArgs {}

効果値が持つ、型を消したシェーダー引数です。値は持っている引数で比較されます。ゲームが直接作ることはありません。

構造体：Filter

pub struct Filter {
    shader: ShaderAsset,
    args: ShaderArgs,
}

色フィルター、つまり色シェーダーとその引数です。フィルターは覆うものの色を変えます。画面フィルターなら Background、Stage、Front プレーン、エンティティのフィルターならそのエンティティです。

filter(shader, args)

pub const fn filter<A: ShaderArg>(shader: ColorShader<A>, args: A) -> Filter

• shader ColorShader<A> — シェーダー。
• args A — その引数。
• 戻り値：Filter — args を与えたフィルター shader。
• 種別：const fn · ビルトイン：いいえ。

screen.filter().change(Some(filter(MEMORY, Memory { strength: 0.8 }))).apply_animation(tween(ms(800)));

構造体：Mix

pub struct Mix {
    shader: ShaderAsset,
    args: ShaderArgs,
}

エンティティを下にあるものへ合成する方法、つまりミックスシェーダーとその引数です。シェーダーはエンティティと背景を見て合成後の画素を返すので、ブレンドモードやすりガラスのような効果はミックスです。

mix(shader, args)

pub const fn mix<A: ShaderArg>(shader: MixShader<A>, args: A) -> Mix

• 戻り値：Mix — args を与えたミックス shader。
• 種別：const fn · ビルトイン：いいえ。

構造体：Mask

pub struct Mask {
    shader: ShaderAsset,
    args: ShaderArgs,
}

アルファマスク、つまりマスクシェーダーとその引数です。シェーダーは矩形の各画素に 0.0 から 1.0 の値を返します。マスクは 3 か所で使います。

• Entity::mask：エンティティの矩形の上で、エンティティのアルファにマスクが乗算されます。
• Paint::masked：ペイントの上で、ペイントのアルファにマスクが乗算されます。
• anim::masked：移動するしきい値がマスクの値に達した画素から、トランジションが切り替わります。

mask(shader, args)

pub const fn mask<A: ShaderArg>(shader: MaskShader<A>, args: A) -> Mask

• 戻り値：Mask — args を与えたマスク shader。
• 種別：const fn · ビルトイン：いいえ。

構造体：Paint

pub struct Paint {
    texture: ShaderAsset,
    args: ShaderArgs,
    size: Size,
    mask: Option<Mask>,
}

size ピクセルの生成された画像内容、つまりテクスチャーシェーダーとその引数で、マスクを付けることもできます。ImageLayer は ImageLayer::paint で、画像の代わりにペイントを表示します。ペイントは size ピクセルの画像と同じように配置、サイズ決定、反転され、トランジションで差し替えられます。グラデーション、光の玉、天候はペイントです。

paint(shader, args, size)

pub const fn paint<A: ShaderArg>(shader: TextureShader<A>, args: A, size: Size) -> Paint

• size Size — 内容のサイズ（ピクセル）。
• 戻り値：Paint — shader が args で描く size ピクセルの内容。マスクなし。
• 種別：const fn · ビルトイン：いいえ。

paint.masked(mask)

pub const fn masked(mut self, mask: Mask) -> Paint

• 戻り値：ペイントの矩形の上で計算した mask をアルファに乗算した、このペイント。2 回目の masked は最初のマスクを置き換えます。
• 種別：const fn · ビルトイン：いいえ。

use std::screen::{degrees, size};
use std::shaders::mask::rounded_rect;
use std::shaders::texture::linear_gradient;

screen.entity(PANEL).image().paint(linear_gradient(degrees(90.0), WHITE, BLACK, size(400, 300)).masked(rounded_rect(32.0, 4.0))).apply_animation(fade(ms(300)));

列挙型：LocalMotionBehavior

pub enum LocalMotionBehavior {
    Periodic { after: Duration, period: Duration },
    Stall { after: Duration },
}

ローカルモーションの時刻の進み方です。ローカルモーションのシェーダーは秒単位の時刻 t を受け取ります。振る舞いは、モーション開始からの時間をシェーダーに渡す前に変換します。

Periodic { after: ZERO, period } は単純なループで、0 でない after はループの前に導入部を再生します。Stall は、減衰する揺れのように落ち着くモーションに向いています。

構造体：LocalMotion

pub struct LocalMotion {
    shader: ShaderAsset,
    args: ShaderArgs,
    behavior: LocalMotionBehavior,
}

エンティティのポーズの周りのモーション、つまりローカルモーションシェーダーとその引数、時刻の規則です。シェーダーはそのフレームでのエンティティのポーズ（トゥイーンと Motion を反映したもの）を受け取り、描くポーズを返します。変わるのはエンティティの描き方だけで、論理的な位置、拡大率、回転はそのままです。

local_motion(shader, args, behavior)

pub const fn local_motion<A: ShaderArg>(shader: LocalMotionShader<A>, args: A, behavior: LocalMotionBehavior) -> LocalMotion

• behavior LocalMotionBehavior — モーションの時刻の進み方。
• 戻り値：LocalMotion — args を与え、時刻を behavior で変換するローカルモーション shader。
• 種別：const fn · ビルトイン：いいえ。

構造体：TransitionalMotion

pub struct TransitionalMotion {
    shader: ShaderAsset,
    args: ShaderArgs,
    duration: Duration,
    easing: Easing,
    delay: Duration,
}

あるポーズから別のポーズへの経路、つまり遷移モーションシェーダーとその引数、タイミングです。Entity::travel がエンティティをこれに沿って動かします。シェーダーは開始ポーズ、終了ポーズ、イージング適用後の 0 から 1 の進行度、時刻を受け取り、描くポーズを返します。長さが過ぎると、シェーダーが何を返したかにかかわらず、エンティティは終了ポーズにあります。

transitional_motion(shader, args, duration)

pub const fn transitional_motion<A: ShaderArg>(shader: TransitionalMotionShader<A>, args: A, duration: Duration) -> TransitionalMotion

• duration Duration — トラベルにかかる時間。
• 戻り値：TransitionalMotion — args を与え、duration かけて進むモーション shader。イージングは Linear、遅延なし。
• 種別：const fn · ビルトイン：いいえ。

motion.ease(easing)、motion.delay(delay)

pub const fn ease(mut self, easing: Easing) -> TransitionalMotion
pub const fn delay(mut self, delay: Duration) -> TransitionalMotion

ease は進行度に easing をかけたこのモーションを返し、delay はカーソルの delay 後に始まるこのモーションを返します。イージングはトゥイーンと同じく検査され、不正な CubicBezier や Steps(0) は定数評価エラーです。種別：const fn · ビルトイン：いいえ。

use std::screen::{degrees, pose};
use std::screen::anim::Easing;
use std::shaders::motion::arc;

screen.entity(BIRD).travel(pose(point(900, 400), 1.0, degrees(0.0)), arc(200.0, ms(1200)).ease(Easing::OutQuad));